REGISTER_DETAILS

 

The REGISTER_DETAILS structure contains information to allow application software to determine if it wants to accept a registration request from another application or device.

 

If your application needs to perform registrar oriented services in support of other telephony applications or devices, then it can process the SipRegisterReceived event. When it does, it will have access to a REGISTER_DETAILS structure in memory. Your application can take the contents of this structure to determine if the far end entity can register with your application.

 

 

typedef struct

{

char *pRegistrationDomain;

 

char *pToName;

char *pToHost;

char *pToPort;

 

char *pContactName;

char *pContactHost;

char *pContactPort;

 

char *pReceivedFromIpAddress;

char *pReceivedFromPort;

 

char *pExpiresTimeSeconds;

char *pRawSipMesage;

 

BOOL AcceptRegistration;

 

}REGISTER_DETAILS;

 

 

 

Members:

 

pRegistrationDomain

The domain name the far end is using.

 

pToName

The name the far end device wants to register. This name (or extension phone number) is used by your application as the key for looking up the binding address information for a user (i.e IP address and port of the registered user).

 

pToHost

The host name of the device that is registering.

 

pToPort

The network port of the device that is registering.

 

pContactName

Used as binding information. Devices generally set this to the same value as the pToName member.

 

pContactHost

Used as binding information. Devices generally set this to their IP address.

 

pContactPort

Used as binding information. Devices generally set this to their UDP port they are using for receiving protocol data.

 

pReceivedFromIpAddress

The real IP address that the registration request came from. A registration based application may have use for this information if the telephony network environment uses NAT routers and/or firewall network elements.

 

pReceivedFromPort

The real network port that the registration request came from. A registration based application may have use for this information if the telephony network environment uses NAT routers and/or firewall network elements.

 

pExpiresTimeSeconds

The time in seconds the far end device wants to be registered. If this value is set to zero, then the far end device no longer wishes to be registered.

 

pRawSipMesage

The address of a buffer that contains the raw SIP protocol REGISTER message.

 

AcceptRegistration

If your application determines that it wants to accept the registration request from the far end device, then it should set this member to a non zero value before returning execution back to the media engine from the event handler. If the registration request is not acceptable, then this member should be set to zero.