ClientObserver

#include <icy/turn/client/client.h>

struct ClientObserver

Abstract observer interface for TURN client events. Callers subclass this to receive allocation lifecycle and data relay callbacks.

Public Methods

Return	Name	Description
`void`	`onClientStateChange` virtual	Called whenever the client's state machine transitions to a new state.
`void`	`onRelayDataReceived` virtual	Called when relayed data is received from a peer via a Data Indication.
`void`	`onAllocationFailed` virtual inline	Called when the server rejects an Allocate request with an error.
`void`	`onAllocationDeleted` virtual inline	Called when the server confirms deletion of the allocation.
`void`	`onAllocationPermissionsCreated` virtual inline	Called after a CreatePermission request succeeds.
`void`	`onTransactionResponse` virtual inline	All received transaction responses will be routed here after local processing so the observer can easily implement extra functionality.
`void`	`onTimer` virtual inline	Fires after the client's internal timer callback. Handy for performing extra async cleanup tasks.

virtual

virtual void onClientStateChange(Client & client, ClientState & state, const ClientState & oldState)

Called whenever the client's state machine transitions to a new state.

Parameter	Type	Description
`client`	`Client` &	The client that changed state.
`state`	`ClientState` &	The new state.
`oldState`	const `ClientState` &	The previous state.

virtual

virtual void onRelayDataReceived(Client & client, const char * data, size_t size, const net::Address & peerAddress)

Called when relayed data is received from a peer via a Data Indication.

Parameter	Type	Description
`client`	`Client` &	The owning client.
`data`	`const char *`	Pointer to the received payload bytes.
`size`	`size_t`	Number of bytes in `data`.
`peerAddress`	const `net::Address` &	Source address of the remote peer.

virtual inline

virtual inline void onAllocationFailed(Client & client, int errorCode, const std::string & reason)

Called when the server rejects an Allocate request with an error.

Parameter	Type	Description
`client`	`Client` &	The owning client.
`errorCode`	`int`	STUN error code (e.g. 401, 438).
`reason`	`const std::string &`	Human-readable error reason string.

virtual inline

virtual inline void onAllocationDeleted(Client & client, const stun::Transaction & transaction)

Called when the server confirms deletion of the allocation.

Parameter	Type	Description
`client`	`Client` &	The owning client.
`transaction`	const `stun::Transaction` &	The completed Refresh transaction (lifetime == 0).

virtual inline

virtual inline void onAllocationPermissionsCreated(Client & client, const PermissionList & permissions)

Called after a CreatePermission request succeeds.

Parameter	Type	Description
`client`	`Client` &	The owning client.
`permissions`	const `PermissionList` &	The full list of active permissions after this update.

virtual inline

virtual inline void onTransactionResponse(Client & client, const stun::Transaction & transaction)

All received transaction responses will be routed here after local processing so the observer can easily implement extra functionality.

Parameter	Type	Description
`client`	`Client` &	The owning client.
`transaction`	const `stun::Transaction` &	The completed transaction (request + response accessible).

virtual inline

virtual inline void onTimer(Client & client)

Fires after the client's internal timer callback. Handy for performing extra async cleanup tasks.

Parameter	Type	Description
`client`	`Client` &	The owning client.