HP-UX C SIP Stack Programmer's Guide (Novembery 2007)

Working with Register-Clients 131

API

The Register-Client API contains a set of functions and function callbacks that

allow you to set or examine register-client parameters, control REGISTER

requests and respond to network events.

ARAMETERS

You can set or examine register-client parameters via Register-Client API Set

and Get functions. The following parameters are available:

To Header and From Header

When creating a new register-client object, you must set the To and From

headers of the object. After you send a REGISTER request from this object, you

must not change the To and From header values.

Contact Headers List

The register-client object manages a list of Contact headers. The API allows you

to add, remove and view Contact headers from the contact header list. When

sending a REGISTER request, the register-client object adds all the Contact

headers from the list to the outgoing REGISTER message.

Expires Header

The application can set an Expires header to the register-client object. When

sending a REGISTER request, the register-client object adds this Expires header

to the outgoing REGISTER message.

Registrar

Before registering to a Registrar, you must set the Registrar address in the

registrar-client object. When the register-client receives a 3xx class response,

the register-client will update the Registrar address with the first contact header

that is found in the response. The application can view and change the Registrar

address as necessary. You can update the Registrar address prior to sending a

State

The register-client state parameter indicates the state of the registration process.

You can access the state parameter only with a Get function. The state parameter

is not modifiable.