voice-gateway-service/pjproject/pjsip/include/pjsip-ua/sip_regc.h

/* 
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJSIP_SIP_REG_H__
#define __PJSIP_SIP_REG_H__

/**
 * @file sip_regc.h
 * @brief SIP Registration Client
 */

#include <pjsip/sip_types.h>
#include <pjsip/sip_auth.h>
#include <pjsip/sip_transport.h>


/**
 * @defgroup PJSUA_REGC Client Registration
 * @ingroup PJSIP_HIGH_UA
 * @brief High Layer API for performing client registration.
 * @{
 *
 * This provides API for performing client registration. Application must
 * link with  <b>pjsip-ua</b> static library to use this API.

 */


PJ_BEGIN_DECL

/** Typedef for client registration data. */
typedef struct pjsip_regc pjsip_regc;

/** Maximum contacts in registration. */
#define PJSIP_REGC_MAX_CONTACT  10

/** Expiration not specified. */
#define PJSIP_REGC_EXPIRATION_NOT_SPECIFIED     PJSIP_EXPIRES_NOT_SPECIFIED

/** Buffer to hold all contacts. */
#define PJSIP_REGC_CONTACT_BUF_SIZE     512

/** Structure to hold parameters when calling application's callback.
 *  The application's callback is called when the client registration process
 *  has finished.
 */
struct pjsip_regc_cbparam
{
    pjsip_regc          *regc;      /**< Client registration structure.     */
    void                *token;     /**< Arbitrary token set by application */

    /** Error status. If this value is non-PJ_SUCCESS, some error has occured.
     *  Note that even when this contains PJ_SUCCESS the registration might
     *  have failed; in this case the \a code field will contain non
     *  successful (non-2xx status class) code
     */
    pj_status_t          status;
    int                  code;      /**< SIP status code received.          */
    pj_str_t             reason;    /**< SIP reason phrase received.        */
    pjsip_rx_data       *rdata;     /**< The complete received response.    */
    unsigned             expiration;/**< Next expiration interval,
                                         PJSIP_REGC_EXPIRATION_NOT_SPECIFIED
                                         if not specified.                  */
    int                  contact_cnt;/**<Number of contacts in response.    */
    pjsip_contact_hdr   *contact[PJSIP_REGC_MAX_CONTACT]; /**< Contacts.    */
    pj_bool_t            is_unreg;  /**< Expire header, if any, set to zero?*/
};


/** Type declaration for callback to receive registration result. */
typedef void pjsip_regc_cb(struct pjsip_regc_cbparam *param);

/**
 * Structure to hold parameters when calling application's callback
 * specified in #pjsip_regc_set_reg_tsx_cb().
 * To update contact address, application can set the field contact_cnt
 * and contact inside the callback.
 */
struct pjsip_regc_tsx_cb_param
{
    /** cbparam */
    struct pjsip_regc_cbparam   cbparam;

    /** Number of Contacts */
    int                         contact_cnt;

    /** Array of Contacts */
    pj_str_t                    contact[PJSIP_REGC_MAX_CONTACT];
};

/** Type declaration for callback set in #pjsip_regc_set_reg_tsx_cb(). */
typedef void pjsip_regc_tsx_cb(struct pjsip_regc_tsx_cb_param *param);

/**
 * Client registration information.
 */
struct pjsip_regc_info
{
    pj_str_t    server_uri; /**< Server URI,                                */
    pj_str_t    client_uri; /**< Client URI (From header).                  */
    pj_bool_t   is_busy;    /**< Have pending transaction?                  */
    pj_bool_t   auto_reg;   /**< Will register automatically?               */
    unsigned    interval;   /**< Registration interval (seconds).           */
    unsigned    next_reg;   /**< Time until next registration (seconds).    */
    pjsip_transport *transport; /**< Last transport used, for informational
                                     purpose only (e.g: comparing pointers),
                                     the transport may be invalid already.  */
};

/**
 * @see pjsip_regc_info
 */
typedef struct pjsip_regc_info pjsip_regc_info;


/**
 * Get the module instance for client registration module.
 *
 * @return          client registration module.
 */
PJ_DECL(pjsip_module*) pjsip_regc_get_module(void);


/**
 * Create client registration structure.
 *
 * @param endpt     Endpoint, used to allocate pool from.
 * @param token     A data to be associated with the client registration struct.
 * @param cb        Pointer to callback function to receive registration status.
 * @param p_regc    Pointer to receive client registration structure.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_create( pjsip_endpoint *endpt, void *token,
                                        pjsip_regc_cb *cb, 
                                        pjsip_regc **p_regc);


/**
 * Destroy client registration structure. If a registration transaction is
 * in progress, then the structure will be deleted only after a final response
 * has been received, and in this case, the callback won't be called.
 *
 * @param regc      The client registration structure.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_destroy(pjsip_regc *regc);


/**
 * Destroy client registration structure. If a registration transaction is
 * in progress:
 * - if force is PJ_TRUE, then the structure will be deleted only after
 *   a final response has been received, and in this case, the callback
 *   won't be called (this behavior is the same as calling
 *   pjsip_regc_destroye()).
 * - if force is PJ_FALSE, the function will return PJ_EBUSY
 *
 * @param regc      The client registration structure.
 * @param force     Specify if the function must destroy the structure.
 *
 * @return          PJ_SUCCESS on success, or PJ_EBUSY.
 */
PJ_DECL(pj_status_t) pjsip_regc_destroy2(pjsip_regc *regc, pj_bool_t force);


/**
 * Get registration info.
 *
 * @param regc      The client registration structure.
 * @param info      Client registration info.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_get_info( pjsip_regc *regc,
                                          pjsip_regc_info *info );


/**
 * Get the memory pool associated with a registration client handle.
 *
 * @param regc      The client registration structure.
 * @return pool     handle.
 */
PJ_DECL(pj_pool_t*) pjsip_regc_get_pool(pjsip_regc *regc);

/**
 * Initialize client registration structure with various information needed to
 * perform the registration.
 *
 * @param regc      The client registration structure.
 * @param srv_url   Server URL.
 * @param from_url  The person performing the registration, must be a SIP URL type.
 * @param to_url    The address of record for which the registration is targetd, must
 *                  be a SIP/SIPS URL.
 * @param ccnt      Number of contacts in the array.
 * @param contact   Array of contacts, each contact item must be formatted
 *                  as described in RFC 3261 Section 20.10:
 *                  When the header field value contains a display 
 *                  name, the URI including all URI parameters is 
 *                  enclosed in "<" and ">".  If no "<" and ">" are 
 *                  present, all parameters after the URI are header
 *                  parameters, not URI parameters.  The display name 
 *                  can be tokens, or a quoted string, if a larger 
 *                  character set is desired.
 * @param expires   Default expiration interval (in seconds) to be applied for
 *                  contact URL that doesn't have expiration settings. If the
 *                  value PJSIP_REGC_EXPIRATION_NOT_SPECIFIED is given, then 
 *                  no default expiration will be applied.
 * @return          zero on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_init(pjsip_regc *regc,
                                     const pj_str_t *srv_url,
                                     const pj_str_t *from_url,
                                     const pj_str_t *to_url,
                                     int ccnt,
                                     const pj_str_t contact[],
                                     pj_uint32_t expires);


/**
 * Increment busy counter temporarily, to prevent client registration
 * structure from being destroyed.
 *
 * @param regc      The client registration structure.
 */
PJ_DECL(void) pjsip_regc_add_ref( pjsip_regc *regc );


/**
 * Decrement temporary busy counter. After this function
 * is called, client registration structure may have been destroyed
 * if there's a pending destroy.
 *
 * @param regc      The client registration structure.
 *
 * @return          PJ_SUCCESS on success. PJ_EGONE if the registration
 *                  structure has been destroyed inside the function.
 */
PJ_DECL(pj_status_t) pjsip_regc_dec_ref( pjsip_regc *regc );


/**
 * Set callback to be called when the registration received a final response.
 * This callback is different with the one specified during creation via
 * #pjsip_regc_create(). This callback will be called for any final response
 * (including 401/407/423) and before any subsequent requests are sent.
 * In case of unregistration, this callback will not be called.
 *
 * @param regc      The client registration structure.
 * @param tsx_cb    Pointer to callback function to receive registration status.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_set_reg_tsx_cb(pjsip_regc *regc,
                                               pjsip_regc_tsx_cb *tsx_cb);

/**
 * Set the "sent-by" field of the Via header for outgoing requests.
 *
 * @param regc      The client registration structure.
 * @param via_addr  Set via_addr to use for the Via header or NULL to use
 *                  the transport's published name.
 * @param via_tp    via_addr will only be used if we are using via_tp
 *                  transport.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_set_via_sent_by(pjsip_regc *regc,
                                                pjsip_host_port *via_addr,
                                                pjsip_transport *via_tp);

/**
 * Set the number of seconds to refresh the client registration before
 * the registration expires.
 *
 * @param regc      The registration structure.
 * @param delay     The number of seconds to refresh the client
 *                  registration before the registration expires.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t)
pjsip_regc_set_delay_before_refresh( pjsip_regc *regc,
                                     pj_uint32_t delay );


/**
 * Set authentication credentials to use by this registration.
 *
 * @param regc      The registration structure.
 * @param count     Number of credentials in the array.
 * @param cred      Array of credentials.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_set_credentials( pjsip_regc *regc,
                                                 int count,
                                                 const pjsip_cred_info cred[] );

/**
 * Set authentication preference.
 *
 * @param regc      The registration structure.
 * @param pref      Authentication preference.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_set_prefs( pjsip_regc *regc,
                                           const pjsip_auth_clt_pref *pref);

/**
 * Set route set to be used for outgoing requests.
 *
 * @param regc      The client registration structure.
 * @param route_set List containing Route headers.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_set_route_set(pjsip_regc *regc,
                                              const pjsip_route_hdr*route_set);


/**
 * Lock/bind client registration to a specific transport/listener. 
 * This is optional, as normally transport will be selected automatically
 * based on the destination of requests upon resolver completion. 
 * When the client registration is explicitly bound to the specific 
 * transport/listener, all UAC transactions originated by the client
 * registration will use the specified transport/listener when sending 
 * outgoing requests.
 *
 * Note that this doesn't affect the Contact header set for this client
 * registration. Application must manually update the Contact header if
 * necessary, to adjust the address according to the transport being
 * selected.
 *
 * @param regc      The client registration instance.
 * @param sel       Transport selector containing the specification of
 *                  transport or listener to be used by this session
 *                  to send requests.
 *
 * @return          PJ_SUCCESS on success, or the appropriate error code.
 */
PJ_DECL(pj_status_t) pjsip_regc_set_transport(pjsip_regc *regc,
                                              const pjsip_tpselector *sel);

/**
 * Release the reference to current transport being used by the regc, if any.
 * The regc keeps the reference to the last transport being used in order
 * to prevent it from being destroyed. In some situation however, such as
 * when the transport is disconnected, it is necessary to instruct the
 * regc to release this reference so that the transport can be destroyed.
 * See https://github.com/pjsip/pjproject/issues/1481 for background info.
 *
 * @param regc      The client registration instance.
 *
 * @return          PJ_SUCCESS on success, or the appropriate error code.
 */
PJ_DECL(pj_status_t) pjsip_regc_release_transport(pjsip_regc *regc);

/**
 * Add headers to be added to outgoing REGISTER requests.
 *
 * @param regc      The client registration structure.
 * @param hdr_list  List containing SIP headers to be added for all outgoing
 *                  REGISTER requests.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_add_headers(pjsip_regc *regc,
                                            const pjsip_hdr *hdr_list);


/**
 * Create REGISTER request for the specified client registration structure.
 *
 * After successfull registration, application can inspect the contacts in
 * the client registration structure to list what contacts are associaciated
 * with the address of record being targeted in the registration.
 *
 * @param regc      The client registration structure.
 * @param autoreg   If non zero, the library will automatically refresh the
 *                  next registration until application unregister.
 * @param p_tdata   Pointer to receive the REGISTER request.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_register(pjsip_regc *regc, pj_bool_t autoreg,
                                         pjsip_tx_data **p_tdata);


/**
 * Create REGISTER request to unregister the contacts that were previously
 * registered by this client registration.
 *
 * @param regc      The client registration structure.
 * @param p_tdata   Pointer to receive the REGISTER request.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_unregister(pjsip_regc *regc,
                                           pjsip_tx_data **p_tdata);

/**
 * Create REGISTER request to unregister all contacts from server records.
 * Note that this will unregister all registered contact for the AOR
 * including contacts registered by other user agents. To only unregister
 * contact registered by this client registration instance, use
 * #pjsip_regc_unregister() instead.
 *
 * @param regc      The client registration structure.
 * @param p_tdata   Pointer to receive the REGISTER request.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_unregister_all(pjsip_regc *regc,
                                               pjsip_tx_data **p_tdata);

/**
 * Update Contact details in the client registration structure. For each
 * contact, if the contact is not found in existing contact, it will be
 * added to the Contact list. If it matches existing contact, nothing
 * will be added. This function will also mark existing contacts which
 * are not specified in the new contact list as to be removed, by adding
 * "expires=0" parameter to these contacts.
 *
 * Once the contact list has been updated, application must update the
 * registration by creating a new REGISTER request and send it to the
 * registrar. This request will contain both old and new contacts; the
 * old contacts will have it's expires parameter set to zero to instruct
 * the registrar to remove the bindings.
 *
 * @param regc      The client registration structure.
 * @param ccnt      Number of contacts.
 * @param contact   Array of contacts, each contact item must be formatted
 *                  as described in RFC 3261 Section 20.10:
 *                  When the header field value contains a display 
 *                  name, the URI including all URI parameters is 
 *                  enclosed in "<" and ">".  If no "<" and ">" are 
 *                  present, all parameters after the URI are header
 *                  parameters, not URI parameters.  The display name 
 *                  can be tokens, or a quoted string, if a larger 
 *                  character set is desired.
 * @return          PJ_SUCCESS if sucessfull.
 */
PJ_DECL(pj_status_t) pjsip_regc_update_contact( pjsip_regc *regc,
                                                int ccnt,
                                                const pj_str_t contact[] );

/**
 * Update the expires value. The next REGISTER request will contain
 * new expires value for the registration.
 *
 * @param regc      The client registration structure.
 * @param expires   The new expires value.
 * @return          zero on successfull.
 */
PJ_DECL(pj_status_t) pjsip_regc_update_expires( pjsip_regc *regc,
                                                pj_uint32_t expires );

/**
 * Sends outgoing REGISTER request.
 * The process will complete asynchronously, and application
 * will be notified via the callback when the process completes.
 *
 * @param regc      The client registration structure.
 * @param tdata     Transmit data.
 *
 * @return          PJ_SUCCESS on success.
 */
PJ_DECL(pj_status_t) pjsip_regc_send(pjsip_regc *regc, pjsip_tx_data *tdata);


PJ_END_DECL

/**
 * @}
 */

#endif  /* __PJSIP_REG_H__ */