# OpalParamRegistration Struct Reference

`#include <opal.h>`

List of all members.

## Public Attributes

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
unsigned | m_messageWaiting

## Detailed Description

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

## Member Data Documentation

const char* OpalParamRegistration::m_protocol

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

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 value will have "@" and the OpalParamRegistration::m_hostName field apepnded to it to create and Address-Of_Record.

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.

const char* OpalParamRegistration::m_authUserName

User name for authentication.

const char* OpalParamRegistration::m_password

Password for authentication with server.

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.

unsigned OpalParamRegistration::m_timeToLive

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

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_messageWaiting

Time in seconds for Message Waiting subscription time to live. If non-zero then a subscription is attempted with the same server we are registering with. If the subscription is successful, then the OpalIndMessageWaiting indication is sent whenever the message waiting state changes. If zero then no subscription is made.

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

- opal.h