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

Thu, 15 Jan 2015 15:59:08 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 15 Jan 2015 15:59:08 +0100
branch
TOR_BUG_9701
changeset 10
ac0c01689b40
permissions
-rw-r--r--

Implement a real Private Browsing Mode condition by changing the API/ABI;
This solves Tor bug #9701, complying with disk avoidance documented in
https://www.torproject.org/projects/torbrowser/design/#disk-avoidance.

     1 /* This Source Code Form is subject to the terms of the Mozilla Public
     2  * License, v. 2.0. If a copy of the MPL was not distributed with this
     3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     5 #ifndef _CCAPI_SERVICE_H_
     6 #define _CCAPI_SERVICE_H_
     7 #include "cc_constants.h"
     9 /**
    10  * Globals defined in ccapi_service.c
    11  */
    12 extern int g_dev_hdl;
    13 #define G_DEV_NAME_SIZE 64
    14 extern char g_dev_name[G_DEV_NAME_SIZE];
    15 #define G_CFG_P_SIZE 256
    16 extern char g_cfg_p[G_CFG_P_SIZE];
    17 extern int g_compl_cfg;
    19 /**
    20  * Defines the management methods.
    21  */
    23 /**
    24  * The following methods are defined to bring up the pSipcc stack
    25  */
    27 /**
    28  * This function creates various data module needed for initialization of
    29  * Sipcc stack. On reboot or after CCAPI_Service_destroy(), application must call
    30  * first this function followed by CC_Service_start()
    31  *  to bring Sipcc stack in in-service. This function
    32  * need to be called only once.
    33  * @return SUCCESS or FAILURE
    34  */
    35 cc_return_t CCAPI_Service_create();
    37 /**
    38  * Gracefully unload the Sipcc stack. To bring up the pSipcc stack again,
    39  * follow the function calling sequence starting from CCAPI_Service_create().
    40  * @return SUCCESS
    41  */
    42 cc_return_t CCAPI_Service_destroy();
    44 /**
    45  * Bring up the Sipcc stack in service.
    46  *
    47  * @return SUCCESS or FAILURE
    48  */
    49 cc_return_t CCAPI_Service_start();
    51 /**
    52  * Stop Sipcc stack
    53  *
    54  * @return SUCCESS or FAILURE
    55  */
    56 cc_return_t CCAPI_Service_stop();
    58 /**
    59  * CCAPI_Service_reregister
    60  *
    61  * This API will result in stopping the stip stack (i.e unregister) followed
    62  * by parsing of the current config followed by a
    63  * start (i.e register) of the SIP stack, without the download of a new config
    64  * file. This API is used in the APPLY config case
    65  *
    66  * @param device_handle handle of the device, the response is for
    67  * @param device_name
    68  * @param cfg the config file name and path  or the complete configuration
    69  *         in memory.
    70  * @param from_memory boolean flag to indicate if the complete config
    71  *         is sent. This parameter is meant to indicate if the "cfg" parameter
    72  *          points to the file name or is a pointer to the complete config in memory.
    73  * @return
    74  */
    75 cc_return_t CCAPI_Service_reregister (int device_handle, const char *device_name,
    76                              const char *cfg, int from_memory);
    78 /**
    79  * Reset request from the Reset Manager
    80  *
    81  * @return void
    82  */
    83 void CCAPI_Service_reset_request();
    85 #endif /* _CCAPI_SERVICE_H_ */

mercurial