You are here: SwitchKit® Development Environment Programmer’s Guide > 3 Channel Management > sk_monitorChannel() / sk_unMonitorChannel()

sk_monitorChannel() / sk_unMonitorChannel()

Description

Use sk_monitorChannel() to monitor the messages that occur on a specific channel. This function is also available as sk_monitorChannelOnConnection() and skts_monitorChannel().

Your application can monitor a channel whether or not the channel is associated with another application. Monitoring a channel has no effect on the automatic channel allocation process. The sk_requestOutseizedChannel() function can still return a channel that is being monitored.

Monitoring a channel causes a copy of outgoing messages to the switch and incoming messages from the switch to be routed to the monitoring application. Outgoing messages are only routed to the monitoring application when the LLC gets its acknowledgment. The sequence number is then filled in with the status of that acknowledgment. If a monitoring application gets an outseize control message, it can look at its sequence number to see the status of the acknowledgment to that outseize control message. Acknowledgement messages are not sent to monitoring applications.

Use sk_unMonitorChannel() to stop monitoring the messages that occur on a specific channel. This function is also available as sk_unMonitorChannelOnConnection() and skts_unMonitorChannel().

Syntax

int sk_monitorChannel(int aStartSpan, int aStartChannel, int anEndSpan, int anEndChannel);

int sk_unMonitorChannel(int aStartSpan, int aStartChannel, int anEndSpan, int anEndChannel);

int sk_monitorChannelOnConnection(int aStartSpan, int aStartChannel, int anEndSpan, int anEndChannel, int aConID);

int sk_unMonitorChannelOnConnection(int aStartSpan, int aStartChannel, int anEndSpan, int anEndChannel, int aConID);

Threadsafe Syntax

int skts_monitorChannel( int aStartSpan, int aStartChannel, int anEndSpan, int anEndChannel, int aConID );

int skts_unMonitorChannel( int aStartSpan, int aStartChannel, int anEndSpan, int anEndChannel, int aConID );

Parameters

The function parameters are shown in the table below.

Argument | Description
--- | ---
aStartSpan | Specifies the first span to be monitored.
aStartChannel | Specifies the first channel to be monitored.
anEndSpan | Specifies the last span to be monitored.
anEndChannel | Specifies the last channel to be monitored.
aConID | aConID is a connection identifier specified at connection creation time and used to indicate which LLC an application wishes to communicate with.

Return Values

Possible return values for this function:

SK_LOST_LLC | This return value indicates that your application lost contact with the LLC.