media/webrtc/signaling/src/sipcc/include/ccapi_service.h

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/media/webrtc/signaling/src/sipcc/include/ccapi_service.h	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,85 @@
     1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
     1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.6 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.7 +
     1.8 +#ifndef _CCAPI_SERVICE_H_
     1.9 +#define _CCAPI_SERVICE_H_
    1.10 +#include "cc_constants.h"
    1.11 +
    1.12 +/**
    1.13 + * Globals defined in ccapi_service.c
    1.14 + */
    1.15 +extern int g_dev_hdl;
    1.16 +#define G_DEV_NAME_SIZE 64
    1.17 +extern char g_dev_name[G_DEV_NAME_SIZE];
    1.18 +#define G_CFG_P_SIZE 256
    1.19 +extern char g_cfg_p[G_CFG_P_SIZE];
    1.20 +extern int g_compl_cfg;
    1.21 +
    1.22 +/**
    1.23 + * Defines the management methods.
    1.24 + */
    1.25 +
    1.26 +/**
    1.27 + * The following methods are defined to bring up the pSipcc stack
    1.28 + */
    1.29 +
    1.30 +/**
    1.31 + * This function creates various data module needed for initialization of
    1.32 + * Sipcc stack. On reboot or after CCAPI_Service_destroy(), application must call
    1.33 + * first this function followed by CC_Service_start()
    1.34 + *  to bring Sipcc stack in in-service. This function
    1.35 + * need to be called only once.
    1.36 + * @return SUCCESS or FAILURE
    1.37 + */
    1.38 +cc_return_t CCAPI_Service_create();
    1.39 +
    1.40 +/**
    1.41 + * Gracefully unload the Sipcc stack. To bring up the pSipcc stack again,
    1.42 + * follow the function calling sequence starting from CCAPI_Service_create().
    1.43 + * @return SUCCESS
    1.44 + */
    1.45 +cc_return_t CCAPI_Service_destroy();
    1.46 +
    1.47 +/**
    1.48 + * Bring up the Sipcc stack in service.
    1.49 + *
    1.50 + * @return SUCCESS or FAILURE
    1.51 + */
    1.52 +cc_return_t CCAPI_Service_start();
    1.53 +
    1.54 +/**
    1.55 + * Stop Sipcc stack
    1.56 + *
    1.57 + * @return SUCCESS or FAILURE
    1.58 + */
    1.59 +cc_return_t CCAPI_Service_stop();
    1.60 +
    1.61 +/**
    1.62 + * CCAPI_Service_reregister
    1.63 + *
    1.64 + * This API will result in stopping the stip stack (i.e unregister) followed
    1.65 + * by parsing of the current config followed by a
    1.66 + * start (i.e register) of the SIP stack, without the download of a new config
    1.67 + * file. This API is used in the APPLY config case
    1.68 + *
    1.69 + * @param device_handle handle of the device, the response is for
    1.70 + * @param device_name
    1.71 + * @param cfg the config file name and path  or the complete configuration
    1.72 + *         in memory.
    1.73 + * @param from_memory boolean flag to indicate if the complete config
    1.74 + *         is sent. This parameter is meant to indicate if the "cfg" parameter
    1.75 + *          points to the file name or is a pointer to the complete config in memory.
    1.76 + * @return
    1.77 + */
    1.78 +cc_return_t CCAPI_Service_reregister (int device_handle, const char *device_name,
    1.79 +                             const char *cfg, int from_memory);
    1.80 +
    1.81 +/**
    1.82 + * Reset request from the Reset Manager
    1.83 + *
    1.84 + * @return void
    1.85 + */
    1.86 +void CCAPI_Service_reset_request();
    1.87 +
    1.88 +#endif /* _CCAPI_SERVICE_H_ */

mercurial