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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
/*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* 1. Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* <COPYRIGHT HOLDER> OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <inttypes.h>
#include <stdbool.h>
/**
* Abstraction of a single user session:
* for now, only provides accounting of established
* sessions and on-connect/on-disconnect event
* handling, in future: user credentials, protocol, etc.
* Session identifiers grow monotonically.
* 0 sid is reserved to mean 'no session'.
*/
/**
* Create a session.
* Invokes a Lua trigger box.session.on_connect if it is
* defined. Issues a new session identifier.
* Must called by the networking layer
* when a new connection is established.
*
* @return handle for a created session
* @exception tnt_Exception or lua error if session
* trigger fails or runs out of resources.
*/
uint32_t
session_create(int fd, uint64_t cookie);
/**
* Destroy a session.
* Must be called by the networking layer on disconnect.
* Invokes a Lua trigger box.session.on_disconnect if it
* is defined.
* @param session session to destroy. may be NULL.
*
* @exception none
*/
void
session_destroy(uint32_t sid);
/**
* Return a file descriptor
* associated with a session, or -1 if the
* session doesn't exist.
*/
int
session_fd(uint32_t sid);
/**
* Check whether a session exists or not.
*/
static inline bool
session_exists(uint32_t sid)
{
return session_fd(sid) >= 0;
}
/**
* Type of the callback which may be invoked
* on connect or disconnect event.
*/
typedef void (*session_trigger_f)(void *);
struct session_trigger
{
session_trigger_f trigger;
void *param;
};
/* The global on-connect trigger. */
extern struct session_trigger session_on_connect;
/* The global on-disconnect trigger. */
extern struct session_trigger session_on_disconnect;
void
session_init();
void
session_free();
void
session_storage_cleanup(int sid);
|
