Methods
ChannelInfoGet
Retrieves information about the current channel.
Syntax
void ChannelInfoGet( out CHANNEL_INFO _pChannelInfo )
Parameters
_pChannelInfo - Output structure containing channel information.
ChannelDisconnect
Disconnects from the specified peer on the channel.
Syntax
void ChannelDisconnect( string _bsConnectedUPIorID, string _bsReason )
Parameters
_bsConnectedUPIorID - Identifier of the connected peer
_bsReason - Reason for disconnection
ChannelSend
Sends a frame or data to the channel.
Syntax
void ChannelSend( int _nStreamIdx, object _pFrameOrData, string _bsHints )
Parameters
_nStreamIdx - Index of the stream
_pFrameOrData - Data or frame object to send
_bsHints - Hints for sending
ChannelReceive
Receives a frame or data from the channel.
Syntax
void ChannelReceive( int _nTimeoutMsec, int _nStreamIdx, string _bsFromUPIorID, out object _ppFrameOrData, string _bsHints )
Parameters
_nTimeoutMsec - Timeout in milliseconds
_nStreamIdx - Index of the stream
_bsFromUPIorID - Sender's identifier
_ppFrameOrData - Output object receiving the frame or data
_bsHints - Hints for receiving
ChannelMsgSend
Sends a text-based message over the channel.
Syntax
void ChannelMsgSend( string _bsMessageName, string _bsMessageBody, string _bsHints )
Parameters
_bsMessageName - Name of the message
_bsMessageBody - Message content
_bsHints - Hints for message transmission
ChannelMsgReceive
Receives a message from the channel.
Syntax
void ChannelMsgReceive( int _nTimeoutMsec, out string _pbsFromUPIorID, out string _pbsMessageName, out string _pbsMessageBody, string _bsHints )
Parameters
_nTimeoutMsec - Timeout in milliseconds
_pbsFromUPIorID - Output sender identifier
_pbsMessageName - Output message name
_pbsMessageBody - Output message content
_bsHints - Hints for receiving messages
ChannelClose
Closes the channel gracefully.
Syntax
void ChannelClose( string _bsHints )
Parameters
_bsHints - Hints for closing behavior
ChannelAuthOperation
Performs authentication-related operations and updates remote properties.
Syntax
void ChannelAuthOperation( string _bsOperation, string _bsUpdateRemotePropsList, out string _pbsAuthInfoJson, out string _pbsPrevInfoJson )
Parameters
_bsOperation - Authentication operation identifier
_bsUpdateRemotePropsList - Properties to update on the remote peer
_pbsAuthInfoJson - Output authentication result as JSON
_pbsPrevInfoJson - Output previous authentication info as JSON