View Source ow_session (overworld v2.0.0)

Summary

Types

id/0
mfargs/0
proxy_pid/0
serializer/0
token/0
zone_pid/0

Functions

active(EventType, EventContent, Session)
callback_mode()
connect(PID)

Alias for proxy(PID, self())

connected(EventType, EventContent, Session)
disconnect(PID)

Alias for proxy(PID, undefined)

disconnect_callback(PID)

Get the termination callback

disconnect_callback(Callback, PID)

Set the termination callback

disconnected(EventType, EventContent, Session)
game_data(PID)

Get the game data

game_data(Data, PID)

Set the game data

id(PID)

Get the session id of this session (network serializable)

id(PID, SessionID)

Set the session ID for this session (network serializable)

init(_)
latency(PID)

Get the session latency

latency(Latency, PID)

Set the session latency

proxy(PID)

Get the pid of the session's proxy process.

proxy(PID, ProxyPID)

Set the pid of the session's proxy process, including ENet, WebSocket and internal handlers.

serializer(PID)

Get the format for serializing data.

serializer(Serializer, PID)

Set the format for serializing data. If communication happens all within Erlang node(s), then there is no need to set a serializer.

start()

Start the session server and create a new session with this ID

start(Config)
stop(Pid)

Stop the session server

terminate(Reason, State, Data)
token(PID)

Get the session token.

token(Token, PID)

Sets the session token

zone(PID)

Get the zone pid

zone(ZonePID, PID)

Sets the zone pid

Types

Link to this type

id/0

View Source 
-type id() :: pos_integer().
Link to this type

mfargs/0

View Source 
-type mfargs() :: {atom(), atom(), list()}.
Link to this type

proxy_pid/0

View Source 
-type proxy_pid() :: pid() | undefined.
Link to this type

serializer/0

View Source 
-type serializer() :: undefined | protobuf.
Link to this type

token/0

View Source 
-type token() :: binary() | undefined.
Link to this type

zone_pid/0

View Source 
-type zone_pid() :: pid() | undefined.

Functions

Link to this function

active(EventType, EventContent, Session)

View Source
Link to this function

callback_mode()

View Source
Link to this function

connect(PID)

View Source 
-spec connect(pid()) -> {ok, proxy_pid()}.

Alias for proxy(PID, self())

Link to this function

connected(EventType, EventContent, Session)

View Source
Link to this function

disconnect(PID)

View Source 
-spec disconnect(pid()) -> {ok, proxy_pid()}.

Alias for proxy(PID, undefined)

Link to this function

disconnect_callback(PID)

View Source 
-spec disconnect_callback(pid()) -> undefined | mfargs().

Get the termination callback

Link to this function

disconnect_callback(Callback, PID)

View Source 
-spec disconnect_callback(mfargs(), pid()) -> {ok, mfargs()}.

Set the termination callback

Link to this function

disconnected(EventType, EventContent, Session)

View Source
Link to this function

game_data(PID)

View Source 
-spec game_data(pid()) -> any().

Get the game data

Link to this function

game_data(Data, PID)

View Source 
-spec game_data(any(), pid()) -> {ok, any()}.

Set the game data

Link to this function

id(PID)

View Source 
-spec id(pid()) -> id() | undefined.

Get the session id of this session (network serializable)

Link to this function

id(PID, SessionID)

View Source 
-spec id(pid(), id()) -> {ok, id()}.

Set the session ID for this session (network serializable)

Link to this function

init(_)

View Source
Link to this function

latency(PID)

View Source 
-spec latency(pid()) -> non_neg_integer().

Get the session latency

Link to this function

latency(Latency, PID)

View Source 
-spec latency(pos_integer(), pid()) -> {ok, pos_integer()}.

Set the session latency

Link to this function

proxy(PID)

View Source 
-spec proxy(pid()) -> proxy_pid().

Get the pid of the session's proxy process.

Link to this function

proxy(PID, ProxyPID)

View Source 
-spec proxy(pid(), proxy_pid()) -> {ok, proxy_pid()}.

Set the pid of the session's proxy process, including ENet, WebSocket and internal handlers.

Link to this function

serializer(PID)

View Source 
-spec serializer(pid()) -> serializer() | undefined.

Get the format for serializing data.

Link to this function

serializer(Serializer, PID)

View Source 
-spec serializer(serializer(), pid()) -> {ok, serializer()}.

Set the format for serializing data. If communication happens all within Erlang node(s), then there is no need to set a serializer.

Link to this function

start()

View Source 
-spec start() -> {ok, pid()}.

Start the session server and create a new session with this ID

Link to this function

start(Config)

View Source 
-spec start([tuple()]) -> {ok, pid()}.
Link to this function

stop(Pid)

View Source 
-spec stop(pid()) -> ok.

Stop the session server

Link to this function

terminate(Reason, State, Data)

View Source
Link to this function

token(PID)

View Source 
-spec token(pid()) -> token().

Get the session token.

Link to this function

token(Token, PID)

View Source 
-spec token(token(), pid()) -> {ok, token()}.

Sets the session token

Link to this function

zone(PID)

View Source 
-spec zone(pid()) -> zone_pid().

Get the zone pid

Link to this function

zone(ZonePID, PID)

View Source 
-spec zone(zone_pid(), pid()) -> {ok, pid()}.

Sets the zone pid