PortSIP VoIP SDK Manual for Windows  16.2
PortSIP features our newest, supported, quality-assured VoIP SDK used by Several hundred companies around the world for easy VoIP application develop and quality-assured code.
Functions
INFO/OPTIONS message events

Functions

Int32 PortSIP.SIPCallbackEvents.onRecvOptions (Int32 callbackIndex, Int32 callbackObject, StringBuilder optionsMessage)
 
Int32 PortSIP.SIPCallbackEvents.onRecvInfo (Int32 callbackIndex, Int32 callbackObject, StringBuilder infoMessage)
 
Int32 PortSIP.SIPCallbackEvents.onRecvNotifyOfSubscription (Int32 callbackIndex, Int32 callbackObject, Int32 subscribeId, StringBuilder notifyMsg, byte[] contentData, Int32 contentLenght)
 
Int32 PortSIP.SIPCallbackEvents.onSubscriptionFailure (Int32 callbackIndex, Int32 callbackObject, Int32 subscribeId, Int32 statusCode)
 
Int32 PortSIP.SIPCallbackEvents.onSubscriptionTerminated (Int32 callbackIndex, Int32 callbackObject, Int32 subscribeId)
 

Detailed Description

Function Documentation

◆ onRecvOptions()

Int32 PortSIP.SIPCallbackEvents.onRecvOptions ( Int32  callbackIndex,
Int32  callbackObject,
StringBuilder  optionsMessage 
)

This event will be triggered when receiving the OPTIONS message.

Parameters
optionsMessageThe received whole OPTIONS message in text format.

◆ onRecvInfo()

Int32 PortSIP.SIPCallbackEvents.onRecvInfo ( Int32  callbackIndex,
Int32  callbackObject,
StringBuilder  infoMessage 
)

This event will be triggered when receiving the INFO message.

Parameters
infoMessageThe received whole INFO message in text format.

◆ onRecvNotifyOfSubscription()

Int32 PortSIP.SIPCallbackEvents.onRecvNotifyOfSubscription ( Int32  callbackIndex,
Int32  callbackObject,
Int32  subscribeId,
StringBuilder  notifyMsg,
byte []  contentData,
Int32  contentLenght 
)

This event will be triggered when receiving a NOTIFY message of the subscription.

Parameters
subscribeIdThe ID of SUBSCRIBE request.
notifyMessageThe received INFO message in text format.
contentDataThe received message body. It's can be either text or binary data.
contentLenghtThe length of "messageData".

◆ onSubscriptionFailure()

Int32 PortSIP.SIPCallbackEvents.onSubscriptionFailure ( Int32  callbackIndex,
Int32  callbackObject,
Int32  subscribeId,
Int32  statusCode 
)

This event will be triggered on sending SUBSCRIBE failure.

Parameters
subscribeIdThe ID of SUBSCRIBE request.
statusCodeThe status code.

◆ onSubscriptionTerminated()

Int32 PortSIP.SIPCallbackEvents.onSubscriptionTerminated ( Int32  callbackIndex,
Int32  callbackObject,
Int32  subscribeId 
)

This event will be triggered when a SUBSCRIPTION is terminated or expired.

Parameters
subscribeIdThe ID of SUBSCRIBE request.