You are here: SwitchKit® Development Environment Programmer’s Guide > 4 Register Functions > sk_msgRegister() / sk_msgUnRegister()

sk_msgRegister() / sk_msgUnRegister()

Description

The sk_msgRegister() function allows your application to receive switch or LLC initiated messages that are not associated with a channel. Registering for these messages does not affect the flow of messages to SwitchManager or to any other process. This message is also available as sk_msgRegisterOnConnection() and skts_msgRegister().

The sk_msgUnRegister() function cancels the sk_msgRegister() call. This message is also available as sk_msgUnRegisterOnConnection() and skts_msgUnRegister().

Syntax

int sk_msgRegister(int aMsgRegisterMask);

int sk_msgUnRegister(int aMsgRegisterMask);

int sk_msgRegisterOnConnection(int aMsgRegisterMask, int aConID);

int sk_msgUnRegisterOnConnection(int aMsgRegisterMask, int aConID);

Threadsafe Syntax

int skts_msgRegister( int aMsgRegisterMask, int aConID );

int skts_msgUnRegister( int aMsgRegisterMask, int aConID);

Parameters

The function parameters are shown in the table below.

Important! All of the bit mask values are defined in SK_API.h. All of the message structures are defined in Messages.api.h. The C++ Classes are defined in CMessages.api.h. All of the messages are documented in the API Reference.

Argument - Bit Mask Value defined in SK_API.h | Message | Originator
--- | --- | ---
SK_ALL_MSGS | All messages | Switch/LLC
SK_POLLS | PollMessage | Switch
SK_ALARMS | Alarm, AlarmCleared | Switch
SK_CSRS | CardStatusReport | Switch
SK_NSRS | NodeStatusReport | Switch
SK_RSRS | RingStatusReport | Switch
SK_DS0S | DS0StatusChange | Switch
SK_PPLEIS | PPLEventIndication | Switch
SK_CONFERENCE_DELETED | ConferenceDeleted ConferenceDeleteRequest | Switch Host
SK_CONFIGMSGS (Internal Use Only) | All configuration messages | Client
SK_CONNECT_STATUS | ConnectionStatusMsg | LLC
SK_CHAN_PROBLEM | ChannelProblem | LLC
SK_CONFIG_STATUS | ConfigStatusMsg | SwitchManager
SK_CPE_ON_CONFERENCE | CallProcessingEvent messages which contain a conference AIB. | Switch
SK_RESOURCE_UTIL_ REPORT | GenericReport (Resource utilization report) | LLC
SK_D_SERVER_REPORT | DeviceServerStatus Report | Switch
SK_SERVER_STATUS_ REPORT | ServerStatusReport | Switch
SK_SERVER_HOST_POLL | ServerHostPoll | Switch
SK_SERVER_STATUS_ CHANGE | ServerStatusChange | LLC
SK_ARP_CACHE_REPORT | ARPCacheReport | Switch
SK_CCS_REP | CCSRedundancy Report | Switch

Argument | Description
--- | ---
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.

A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
In SIP, an application program that sends SIP requests (See also Session Initiation Protocol). Clients may or may not interact directly with a person. Users agents and proxies contain clients (and servers).
See Address Information Block.
See Common Channel Signaling.