UniPRT SDK  v1.0.0.0
ListenerChannelsMgmtMsg Class Reference
Inheritance diagram for ListenerChannelsMgmtMsg:
AMgmtListenerChannels< MgmtMsg >

Public Member Functions

void ListenerChannelConnect (Channel< T > chnlToReconnect, MgmtChannelFilterType chnlType)
 
void ListenerChannelConnect (Channel< T > chnlToReconnect, MgmtChannelFilterType chnlType, String solicitedMsgId)
 Connect or reconnect a channel for listening to messages. More...
 
void ListenerChannelDisconnect (Channel< T > chnlToRemove)
 Disconnect channel. No more messages added to a channel that is disconnected, but the channel can be reconnected in the future.
 
void ListenerChannelDisconnectPermanently (Channel< T > chnlToRemove)
 Disconnect a channel permanently so that it cannot be reconnected.
 
Channel< T > ListenerChannelGetNew (int capacity, MgmtChannelFilterType chnlType)
 
Channel< T > ListenerChannelGetNew (int capacity, MgmtChannelFilterType chnlType, String solicitedMsgId)
 Creates new channel for caller to listen for fully formed JSON msgs. More...
 
void ListenerMsgDeposit (T msgToDeposit, String solicitedMsgId)
 

Member Function Documentation

◆ ListenerChannelConnect()

void ListenerChannelConnect ( Channel< T >  chnlToReconnect,
MgmtChannelFilterType  chnlType,
String  solicitedMsgId 
)
inherited

Connect or reconnect a channel for listening to messages.

solicitedMsgId only applies for channels of MgmtChannelFilterType::MY_SOLICITED_MSGS_ONLY or MgmtChannelFilterType::MY_SOLICITED_AND_UNSOLICITED_MSGS type.

◆ ListenerChannelGetNew()

Channel<T> ListenerChannelGetNew ( int  capacity,
MgmtChannelFilterType  chnlType,
String  solicitedMsgId 
)
inherited

Creates new channel for caller to listen for fully formed JSON msgs.

Channel that holds maximum msgs defined by capacity created where oldest items discarded if unread when newer entries added.
solicitedMsgId only applies for channels of SOLICITED_MSGS_ONLY type.