# RegistrationCtxt API

## Name

RegistrationCtxt API --

## Synopsis

    #include <osipua.h>

    RegistrationCtxt* registration_ctxt_new     ();
    void        registration_ctxt_set_registrar (RegistrationCtxt *ctxt,
                                                 char *registrar);
    void        registration_ctxt_set_password  (RegistrationCtxt *ctxt,
                                                 char *password);
    void        registration_ctxt_set_address_of_record
                                                (RegistrationCtxt *ctxt,
                                                 char *addr_of_rec);
    #define     registration_ctxt_set_expires   (r,e)
    #define     registration_ctxt_set_action    (r,a)
    void        registration_ctxt_destroy       (RegistrationCtxt *ctx);

## Description

## Details

### registration_ctxt_new ()

    RegistrationCtxt* registration_ctxt_new     ();

Creates a new RegistrationCtxt (registration context) to be used with #osip_call_leg_register().

Returns : | a new registration context.

### registration_ctxt_set_registrar ()

    void        registration_ctxt_set_registrar (RegistrationCtxt *ctxt,
                                                 char *registrar);

Sets the registrar address.

ctxt : | a RegistrationCtxt object.
registrar : | the sip url of a registrar.

### registration_ctxt_set_password ()

    void        registration_ctxt_set_password  (RegistrationCtxt *ctxt,
                                                 char *password);

Sets the password to be used for the registration (can be NULL).

ctxt : | a RegistrationCtxt object.
password : | the password to be used for registration.

### registration_ctxt_set_address_of_record ()

    void        registration_ctxt_set_address_of_record
                                                (RegistrationCtxt *ctxt,
                                                 char *addr_of_rec);

ctxt : |
addr_of_rec : |

### registration_ctxt_set_expires()

    #define registration_ctxt_set_expires(r,e) 	(r)->expires=(e)

r : |
e : |

### registration_ctxt_set_action()

    #define registration_ctxt_set_action(r,a) 	(r)->action=(a)

r : |
a : |

### registration_ctxt_destroy ()

    void        registration_ctxt_destroy       (RegistrationCtxt *ctx);

Destroys a registration context.

ctx : | a registration context.