# OpalParamRegistration Struct Reference

`#include <opal.h>`

## Data Fields

const char * | m_protocol
const char * | m_identifier
const char * | m_hostName
const char * | m_authUserName
const char * | m_password
| Password for authentication with server.
const char * | m_adminEntity
unsigned | m_timeToLive
unsigned | m_restoreTime
const char * | m_eventPackage
const char * | m_attributes

## Detailed Description

Registration parameters for the OpalCmdRegistration command. This is only passed to and returned from the OpalSendMessage() function.

Example: `OpalMessage command; OpalMessage * response;`

`H.323 register with gatekeeper memset(&command, 0, sizeof(command)); command.m_type = OpalCmdRegistration; command.m_param.m_registrationInfo.m_protocol = "h323"; command.m_param.m_registrationInfo.m_identifier = "31415"; command.m_param.m_registrationInfo.m_hostName = gk.voxgratia.org; command.m_param.m_registrationInfo.m_password = "secret"; command.m_param.m_registrationInfo.m_timeToLive = 300; response = OpalSendMessage(hOPAL, &command); if (response != NULL && response->m_type == OpalCmdRegistration) m_AddressOfRecord = response->m_param.m_registrationInfo.m_identifier`

`SIP register with regstrar/proxy memset(&command, 0, sizeof(command)); command.m_type = OpalCmdRegistration; command.m_param.m_registrationInfo.m_protocol = "sip"; command.m_param.m_registrationInfo.m_identifier = "rjongbloed@ekiga.net"; command.m_param.m_registrationInfo.m_password = "secret"; command.m_param.m_registrationInfo.m_timeToLive = 300; response = OpalSendMessage(hOPAL, &command); if (response != NULL && response->m_type == OpalCmdRegistration) m_AddressOfRecord = response->m_param.m_registrationInfo.m_identifier`

`Presence registration memset(&command, 0, sizeof(command)); command.m_type = OpalCmdRegistration; command.m_param.m_registrationInfo.m_protocol = "pres"; command.m_param.m_registrationInfo.m_identifier = "sip:rjongbloed@ekiga.net"; command.m_param.m_registrationInfo.m_password = "secret"; command.m_param.m_registrationInfo.m_timeToLive = 300; response = OpalSendMessage(hOPAL, &command); if (response != NULL && response->m_type == OpalCmdRegistration) m_AddressOfRecord = response->m_param.m_registrationInfo.m_identifier`

`unREGISTER memset(&command, 0, sizeof(command)); command.m_type = OpalCmdRegistration; command.m_param.m_registrationInfo.m_protocol = "sip"; command.m_param.m_registrationInfo.m_identifier = m_AddressOfRecord; command.m_param.m_registrationInfo.m_timeToLive = 0; response = OpalSendMessage(hOPAL, &command);`

`Set event package so do SUBSCRIBE memset(&command, 0, sizeof(command)); command.m_type = OpalCmdRegistration; command.m_param.m_registrationInfo.m_protocol = "sip"; command.m_param.m_registrationInfo.m_identifier = "2012@pbx.local"; command.m_param.m_registrationInfo.m_hostName = "sa@pbx.local"; command.m_param.m_registrationInfo.m_eventPackage = OPAL_LINE_APPEARANCE_EVENT_PACKAGE; command.m_param.m_registrationInfo.m_timeToLive = 300; response = OpalSendMessage(hOPAL, &command); if (response != NULL && response->m_type == OpalCmdRegistration) m_AddressOfRecord = response->m_param.m_registrationInfo.m_identifier`

`unSUBSCRIBE memset(&command, 0, sizeof(command)); command.m_type = OpalCmdRegistration; command.m_param.m_registrationInfo.m_protocol = "sip"; command.m_param.m_registrationInfo.m_identifier = m_AddressOfRecord; command.m_param.m_registrationInfo.m_eventPackage = OPAL_LINE_APPEARANCE_EVENT_PACKAGE; command.m_param.m_registrationInfo.m_timeToLive = 0; response = OpalSendMessage(hOPAL, &command);`

## Field Documentation

const char* OpalParamRegistration::m_adminEntity

Identification of the administrative entity. For H.323 this will by the gatekeeper identifier. For SIP this is the authentication realm.

const char* OpalParamRegistration::m_attributes

Protocol dependent information in the form: key=value
key=value
etc

const char* OpalParamRegistration::m_authUserName

User name for authentication.

const char* OpalParamRegistration::m_eventPackage

If non-NULL then this indicates that a subscription is made rather than a registration. The string represents the particular event package being subscribed too. A value of OPAL_MWI_EVENT_PACKAGE will cause an OpalIndMessageWaiting to be sent. A value of OPAL_LINE_APPEARANCE_EVENT_PACKAGE will cause the OpalIndLineAppearance to be sent. Other values are currently not supported.

const char* OpalParamRegistration::m_hostName

Host or domain name for server. For SIP this cannot be NULL. For H.323 a NULL value indicates that a broadcast discovery is be performed. If, for SIP, this contains an "@" and a user part then a "third party" registration is performed.

const char* OpalParamRegistration::m_identifier

Identifier for name to be registered at server. If NULL or empty then the value provided in the OpalParamProtocol::m_userName field of the OpalCmdSetProtocolParameters command is used. Note that for SIP the default value will have "@" and the OpalParamRegistration::m_hostName field apepnded to it to create and Address-Of_Record.

const char* OpalParamRegistration::m_password

Password for authentication with server.

const char* OpalParamRegistration::m_protocol

Protocol prefix for registration. Currently must be "h323" or "sip", cannot be NULL.

unsigned OpalParamRegistration::m_restoreTime

Time in seconds between attempts to restore a registration after registrar/gatekeeper has gone offline. If zero then a default value is used.

unsigned OpalParamRegistration::m_timeToLive

Time in seconds between registration updates. If this is zero then the identifier is unregistered from the server.

The documentation for this struct was generated from the following file:

- opal.h