blob: 3e5584ce2eda0e58170978aff5d98adc08b845d5 (
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
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
120
121
|
#ifndef __dispatch_user_fd_h__
#define __dispatch_user_fd_h__ 1
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
/**
* \defgroup UserFd Server User-File-Descriptor Functions
* @{
*/
typedef struct dx_user_fd_t dx_user_fd_t;
/**
* User_fd Handler
*
* Callback invoked when a user-managed file descriptor is available for reading or writing or there
* was an error on the file descriptor.
*
* @param context The handler context supplied in the dx_user_fd call.
* @param ufd The user_fd handle for the processable fd.
*/
typedef void (*dx_user_fd_handler_cb_t)(void* context, dx_user_fd_t *ufd);
/**
* Set the user-fd handler callback for the server. This handler is optional, but must be supplied
* if the dx_server is used to manage the activation of user file descriptors.
*/
void dx_server_set_user_fd_handler(dx_user_fd_handler_cb_t ufd_handler);
/**
* Create a tracker for a user-managed file descriptor.
*
* A user-fd is appropriate for use when the application opens and manages file descriptors
* for purposes other than AMQP communication. Registering a user fd with the dispatch server
* controls processing of the FD alongside the FDs used for messaging.
*
* @param fd The open file descriptor being managed by the application.
* @param context User context passed back in the connection handler.
* @return A pointer to the new user_fd.
*/
dx_user_fd_t *dx_user_fd(int fd, void *context);
/**
* Free the resources for a user-managed FD tracker.
*
* @param ufd Structure pointer returned by dx_user_fd.
*/
void dx_user_fd_free(dx_user_fd_t *ufd);
/**
* Activate a user-fd for read.
*
* Use this activation when the application has capacity to receive data from the user-fd. This will
* cause the callback set in dx_server_set_user_fd_handler to later be invoked when the
* file descriptor has data to read.
*
* @param ufd Structure pointer returned by dx_user_fd.
*/
void dx_user_fd_activate_read(dx_user_fd_t *ufd);
/**
* Activate a user-fd for write.
*
* Use this activation when the application has data to write via the user-fd. This will
* cause the callback set in dx_server_set_user_fd_handler to later be invoked when the
* file descriptor is writable.
*
* @param ufd Structure pointer returned by dx_user_fd.
*/
void dx_user_fd_activate_write(dx_user_fd_t *ufd);
/**
* Check readable status of a user-fd
*
* Note: It is possible that readable status is spurious (i.e. this function returns true
* but the file-descriptor is not readable and will block if not set to O_NONBLOCK).
* Code accordingly.
*
* @param ufd Structure pointer returned by dx_user_fd.
* @return true iff the user file descriptor is readable.
*/
bool dx_user_fd_is_readable(dx_user_fd_t *ufd);
/**
* Check writable status of a user-fd
*
* @param ufd Structure pointer returned by dx_user_fd.
* @return true iff the user file descriptor is writable.
*/
bool dx_user_fd_is_writeable(dx_user_fd_t *ufd);
/**
* @}
*/
#endif
|
