View Source ow_msg (overworld v2.0.0)

Summary

Functions

decode(Msg, SessionPID)

Decodes a message using the Overworld-specific application decoder.

decode(Msg, SessionPID, EncoderLib, Application)

Decodes a message using the specified encoder library and application. First, it decodes the larger message using the encoder library and application. Then, it looks up the appropriate server callback module based on the decoded call. Finally, it sends the sub-message to the sub-module for further processing and returns the result.

encode(SubMsg, Call)

Encodes a message using the Overworld-specific application encoder. If called from Overworld, the EncoderLib and Application are known.

encode(SubMsg, Call, EncoderLib, Application)

Encodes a message using the specified encoder library and application. It first retrieves the prefix for the application and prepends it to the encoded message.

raw_decode(Msg)

Decodes a raw message and returns the decoded call and sub-message. This function is primarily used for debugging purposes.

Functions

decode(Msg, SessionPID)

-spec decode(binary(), pid()) -> any().

Decodes a message using the Overworld-specific application decoder.

decode(Msg, SessionPID, EncoderLib, Application)

-spec decode(binary(), pid(), atom(), atom()) -> any().

Decodes a message using the specified encoder library and application. First, it decodes the larger message using the encoder library and application. Then, it looks up the appropriate server callback module based on the decoded call. Finally, it sends the sub-message to the sub-module for further processing and returns the result.

encode(SubMsg, Call)

-spec encode(map(), atom()) -> binary().

Encodes a message using the Overworld-specific application encoder. If called from Overworld, the EncoderLib and Application are known.

encode(SubMsg, Call, EncoderLib, Application)

-spec encode(map(), atom(), atom(), atom()) -> binary().

Encodes a message using the specified encoder library and application. It first retrieves the prefix for the application and prepends it to the encoded message.

raw_decode(Msg)

-spec raw_decode(binary()) -> {atom(), map()}.

Decodes a raw message and returns the decoded call and sub-message. This function is primarily used for debugging purposes.