UniPRT SDK  v1.0.0.0
UniPRT.Sdk.Mgmt.IMgmtMsgListenerChannels< T > Interface Template Reference

Listener channels for receiving management messages from printer. More...

Inheritance diagram for UniPRT.Sdk.Mgmt.IMgmtMsgListenerChannels< T >:
UniPRT.Sdk.Mgmt.AMgmtListenerChannels< T >

Public Member Functions

void ListenerChannelConnect (Channel< T > chnlToReconnect, MgmtChannelFilterType chnlType, string solicitedMsgId="")
 Connect or reconnect a channel for listening to msgs. solicitedMsgId only applies for channels of MgmtChannelFilterType::MY_SOLICITED_MSGS_ONLY or MgmtChannelFilterType::MY_SOLICITED_AND_UNSOLICITED_MSGS type.
 
void ListenerChannelDisconnect (Channel< T > chnlToRemove)
 Disconnect channel. No more msgs added to a channel that is disconnected, but 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, string solicitedMsgId="")
 Creates new channel for caller to listen for fully formed JSON msgs. More...
 

Detailed Description

Listener channels for receiving management messages from printer.

Allows for creation or releasing of bounded channel for listening to management messages.
This is useful for listening to management messages sent from printer. Note that only the readable half of the channel should be used by data consumer.

For more details refer to Channels

For more details refer to Readable Half of Channel

Member Function Documentation

◆ ListenerChannelGetNew()

Channel<T> UniPRT.Sdk.Mgmt.IMgmtMsgListenerChannels< T >.ListenerChannelGetNew ( int  capacity,
MgmtChannelFilterType  chnlType,
string  solicitedMsgId = "" 
)

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 MgmtChannelFilterType::ANY_SOLICITED_MSGS_ONLY or MgmtChannelFilterType::MY_SOLICITED_AND_UNSOLICITED_MSGS type.

Implemented in UniPRT.Sdk.Mgmt.AMgmtListenerChannels< T >.