UniPRT SDK  v1.0.0.0
IMgmtMsgListenerChannels< T > Interface Template Reference
Inheritance diagram for IMgmtMsgListenerChannels< T >:
AMgmtListenerChannels< T >

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 messages. More...
 

Member Function Documentation

◆ ListenerChannelConnect()

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

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.

Implemented in AMgmtListenerChannels< T >.

◆ ListenerChannelGetNew()

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

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

Channel that holds a maximum number of messages defined by capacity, where the oldest items are discarded if unread when newer entries are added. solicitedMsgId only applies for channels of MgmtChannelFilterType::ANY_SOLICITED_MSGS_ONLY or MgmtChannelFilterType::MY_SOLICITED_AND_UNSOLICITED_MSGS type.

Implemented in AMgmtListenerChannels< T >.