2 +--------------------------------------------------------------------+
3 | libmemcached - C/C++ Client Library for memcached |
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted under the terms of the BSD license. |
7 | You should have received a copy of the license in a bundled file |
8 | named LICENSE; in case you did not receive a copy you can review |
9 | the terms online at: https://opensource.org/licenses/BSD-3-Clause |
10 +--------------------------------------------------------------------+
11 | Copyright (c) 2006-2014 Brian Aker https://datadifferential.com/ |
12 | Copyright (c) 2020 Michael Wallner <mike@php.net> |
13 +--------------------------------------------------------------------+
18 #include <sys/types.h>
20 typedef long int ssize_t
;
31 #include "libmemcached-1.0/visibility.h"
32 #include "libmemcached-1.0/platform.h"
33 #include "libmemcachedprotocol-0.0/binary.h"
34 #include "libmemcachedprotocol-0.0/callback.h"
36 /* Forward declarations */
38 * You should only access memcached_protocol_st from one thread!,
39 * and never assume anything about the internal layout / sizes of the
42 typedef struct memcached_protocol_st memcached_protocol_st
;
43 typedef struct memcached_protocol_client_st memcached_protocol_client_st
;
50 * Function the protocol handler should call to receive data.
51 * This function should behave exactly like read(2)
53 * @param cookie a cookie used to represent a given client
54 * @param fd the filedescriptor associated with the client
55 * @param buf destination buffer
56 * @param nbuf number of bytes to receive
57 * @return the number of bytes copied into buf
58 * or -1 upon error (errno should contain more information)
60 typedef ssize_t (*memcached_protocol_recv_func
)(const void *cookie
, memcached_socket_t fd
,
61 void *buf
, size_t nbuf
);
64 * Function the protocol handler should call to send data.
65 * This function should behave exactly like write(2)
67 * @param cookie a cookie used to represent a given client
68 * @param fd the filedescriptor associated with the client
69 * @param buf the source buffer
70 * @param nbuf number of bytes to send
71 * @return the number of bytes sent
72 * or -1 upon error (errno should contain more information)
74 typedef ssize_t (*memcached_protocol_send_func
)(const void *cookie
, memcached_socket_t fd
,
75 const void *buf
, size_t nbuf
);
78 * Create an instance of the protocol handler
80 * @return NULL if allocation of an instance fails
83 memcached_protocol_st
*memcached_protocol_create_instance(void);
86 * Get the callbacks associated with a protocol handler instance
87 * @return the callbacks currently used
90 memcached_binary_protocol_callback_st
*
91 memcached_binary_protocol_get_callbacks(memcached_protocol_st
*instance
);
94 * Set the callbacks to be used by the given protocol handler instance
95 * @param instance the instance to update
96 * @param callback the callbacks to use
99 void memcached_binary_protocol_set_callbacks(memcached_protocol_st
*instance
,
100 memcached_binary_protocol_callback_st
*callback
);
103 * Should the library inspect the packages being sent and received and verify
104 * that they are according to the specification? If it encounters an invalid
105 * packet, it will return an EINVAL packet.
107 * @param instance the instance to update
108 * @param enable true if you want the library to check packages, false otherwise
111 void memcached_binary_protocol_set_pedantic(memcached_protocol_st
*instance
, bool enable
);
114 * Is the library inpecting each package?
115 * @param instance the instance to check
116 * @return true it the library is inspecting each package, false otherwise
119 bool memcached_binary_protocol_get_pedantic(memcached_protocol_st
*instance
);
122 * Destroy an instance of the protocol handler
124 * @param instance The instance to destroy
127 void memcached_protocol_destroy_instance(memcached_protocol_st
*instance
);
130 * Set the IO functions used by the instance to send and receive data. The
131 * functions should behave like recv(3socket) and send(3socket).
133 * @param instance the instance to specify the IO functions for
134 * @param recv the function to call for reciving data
135 * @param send the function to call for sending data
138 void memached_protocol_set_io_functions(memcached_protocol_st
*instance
,
139 memcached_protocol_recv_func recv
,
140 memcached_protocol_send_func send
);
143 * Create a new client instance and associate it with a socket
144 * @param instance the protocol instance to bind the client to
145 * @param sock the client socket
146 * @return NULL if allocation fails, otherwise an instance
149 memcached_protocol_client_st
*memcached_protocol_create_client(memcached_protocol_st
*instance
,
150 memcached_socket_t sock
);
153 * Destroy a client handle.
154 * The caller needs to close the socket accociated with the client
155 * <b>before</b> calling this function. This function invalidates the
156 * client memory area.
158 * @param client the client to destroy
161 void memcached_protocol_client_destroy(memcached_protocol_client_st
*client
);
164 void memcached_protocol_client_set_verbose(struct memcached_protocol_client_st
*client
, bool arg
);
167 * Error event means that the client encountered an error with the
168 * connection so you should shut it down
170 #define MEMCACHED_PROTOCOL_ERROR_EVENT 1
172 * Please notify when there is more data available to read
174 #define MEMCACHED_PROTOCOL_READ_EVENT 2
176 * Please notify when it is possible to send more data
178 #define MEMCACHED_PROTOCOL_WRITE_EVENT 4
180 * Backed paused the execution for this client
182 #define MEMCACHED_PROTOCOL_PAUSE_EVENT 8
185 * The different events the client is interested in. This is a bitmask of
186 * the constants defined above.
188 typedef uint32_t memcached_protocol_event_t
;
191 * Let the client do some work. This might involve reading / sending data
192 * to/from the client, or perform callbacks to execute a command.
193 * @param client the client structure to work on
194 * @return The next event the protocol handler will be notified for
197 memcached_protocol_event_t
memcached_protocol_client_work(memcached_protocol_client_st
*client
);
200 * Get the socket attached to a client handle
201 * @param client the client to query
202 * @return the socket handle
205 memcached_socket_t
memcached_protocol_client_get_socket(memcached_protocol_client_st
*client
);
208 * Get the error id socket attached to a client handle
209 * @param client the client to query for an error code
210 * @return the OS error code from the client
213 int memcached_protocol_client_get_errno(memcached_protocol_client_st
*client
);
216 * Get a raw response handler for the given cookie
217 * @param cookie the cookie passed along into the callback
218 * @return the raw reponse handler you may use if you find
219 * the generic callback too limiting
222 memcached_binary_protocol_raw_response_handler
223 memcached_binary_protocol_get_raw_response_handler(const void *cookie
);