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
110
111
112
113
114
115
116
117
118
119
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* 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 parc_EventSocket.h
* @ingroup events
* @brief Socket events
*
* Provides a facade implementing many regularly available event functions.
* This is an interface that software implementors may use to substitute
* different kinds of underlying implementations of these event management functions.
* Notable examples are libevent and libev.
*
*/
#ifndef libparc_parc_EventSocket_h
#define libparc_parc_EventSocket_h
#ifndef _WIN32
#include <sys/socket.h>
#endif
#include <sys/types.h>
/**
* Current implementation based on top of libevent2
*/
#include <parc/algol/parc_EventScheduler.h>
#include <parc/algol/parc_Event.h>
typedef struct PARCEventSocket PARCEventSocket;
typedef void (PARCEventSocket_Callback)(int fd, struct sockaddr *address,
int socklen, void *user_data);
typedef void (PARCEventSocket_ErrorCallback)(PARCEventScheduler *,
int error, char *errorString,
void *user_data);
/**
* Create a socket event handler instance.
*
* The event instance is passed in.
*
* @param [in] parcEventScheduler the scheduler instance
* @param [in] callback the callback function.
* @param [in] errorCallback the error callback function.
* @param [in] userData pointer to private arguments for instance callback function
* @param [in] sa is the socket address to bind to (INET, INET6, LOCAL)
* @param [in] socklen is the sizeof the actual sockaddr (e.g. sizeof(sockaddr_un))
* @returns A pointer to a new PARCEventSocket instance.
*
* Example:
* @code
* {
* }
* @endcode
*
*/
PARCEventSocket *parcEventSocket_Create(PARCEventScheduler *parcEventScheduler,
PARCEventSocket_Callback *callback,
PARCEventSocket_ErrorCallback *errorCallback,
void *userData,
const struct sockaddr *sa, int socklen);
/**
* Destroy a socket event handler instance.
*
* The event instance is passed in.
*
* @param [in] parcEventSocket the address of the instance to destroy.
*
* Example:
* @code
* {
* PARCEvent *event = parcEventSocket_Destroy(&parcEventSocket);
* }
* @endcode
*
*/
void parcEventSocket_Destroy(PARCEventSocket **parcEventSocket);
/**
* Turn on debugging flags and messages
*
* Example:
* @code
* {
* parcEventSocket_EnableDebug();
* }
* @endcode
*
*/
void parcEventSocket_EnableDebug(void);
/**
* Turn off debugging flags and messages
*
* Example:
* @code
* {
* parcEventSocket_DisableDebug();
* }
* @endcode
*
*/
void parcEventSocket_DisableDebug(void);
#endif // libparc_parc_EventSocket_h
|
