\apex\app\interfaces\msgEventMessageInterface

Event Message Interface.

Used for two-way RPC calls, and one-way direct messages.

Summary

Methods
Constants
set_type()
get_type()
get_routing_key()
get_function()
get_caller()
get_request()
get_params()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

set_type()

set_type(string  $type)

Set the message type.

Parameters

string $type

Must be either 'rpc' or 'direct'.

get_type()

get_type(): string

Get the message type.

Returns

string —

The message type

get_routing_key()

get_routing_key(boolean  $return_full = false): string

Get the routing key

Parameters

boolean $return_full

If true, will return the routing key with function name. Defaults to false.

Returns

string —

$routing_key The routing key

get_function()

get_function(): string

et the function name.

Returns

string —

The function name to call.

get_caller()

get_caller(): array

Get the caller array.

Returns

array —

The caller function / class.

get_request()

get_request(): array

Get the contents of the request.

Returns

array —

Various information on the request such as URI, area, IP address, etc.

get_params()

get_params(): array

Get the params of the request.

Returns

array —

The params of the request.