1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/media/webrtc/signaling/src/sipcc/include/reset_api.h Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,51 @@
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 _RESET_API_H_
1.9 +#define _RESET_API_H_
1.10 +
1.11 +
1.12 +/**
1.13 + * resetRequest
1.14 + *
1.15 + * This function tells the reset Manager that the SIPCC module
1.16 + * wants to do a HARD RESET. This is most likely because of a request
1.17 + * from the CUCM.
1.18 + *
1.19 + * The response received for this request is asynchronous and
1.20 + * should be handled via event provided by reset manager.
1.21 + * The CCAPI_Service_shutdown api needs to be called for the
1.22 + * handling of the response to the reset request
1.23 + *
1.24 + */
1.25 +void resetRequest();
1.26 +
1.27 +
1.28 +/**
1.29 + * resetReady
1.30 + *
1.31 + * This function tells the reset manager that call control is
1.32 + * ready for reset. This is called whenever the call control
1.33 + * determines that it is idle
1.34 + *
1.35 + * The resetManager will keep track of events can initate
1.36 + * reset when it has received ready.
1.37 + *
1.38 + */
1.39 +void resetReady();
1.40 +
1.41 +/**
1.42 + * resetNotReady
1.43 + *
1.44 + * This function tells the reset manager that call control is
1.45 + * NOT ready for reset. This is called whenever the call control
1.46 + * is not idle
1.47 + *
1.48 + * The resetManager will keep track of events and it CANNOT initate
1.49 + * reset until a resetReady event is received
1.50 + *
1.51 + */
1.52 +void resetNotReady();
1.53 +
1.54 +#endif /* _RESET_API_H_ */
