blob: 1c76bce0c965d54a2b22da1dc5a0b77a365b9c0f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/*
* Copyright (c) 2014-2015 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License
*/
/**
* @file src/include/cynara-session.h
* @author Aleksander Zdyb <a.zdyb@samsung.com>
* @author Radoslaw Bartosiak <r.bartosiak@samsung.com.pl>
* @author Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
* @author Oskar Switalski <o.switalski@samsung.com>
* @version 1.0
* @brief This file contains Cynara session helper APIs.
* @example cynara-session.example
*/
#ifndef CYNARA_SESSION_H
#define CYNARA_SESSION_H
#include <sys/types.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* \par Description:
* Creates a client session string based on pid and time of creation of client process
*
* \par Purpose:
* This function can be used to create session string identifier used in cynara_check()
* and cynara_async_create_request() functions defined in client libraries.
*
* \par Typical use case:
* The function is called before the call of cynara_check() or cynara_async_create_request()
* function. Returned string is used as client_session param in cynara_check() or
* cynara_async_create_request() function. String is released with free() function.
*
* \par Method of function operation:
* The function generates client session based on the pid and start time of the client process.
* Time is acquired from /proc/PID directory.
*
* \par Sync (or) Async:
* This is a synchronous API.
*
* \par Thread safety:
* This function is thread-safe.
*
* \par Important notes:
* Memory for returned string is obtained with malloc(), and should be freed with free().
*
* \param[in] client_pid client application process identifier (PID).
*
* \return session string on success
* \return NULL on error
*/
char *cynara_session_from_pid(pid_t client_pid);
#ifdef __cplusplus
}
#endif
#endif /* CYNARA_SESSION_H */
|
