X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_server_lib.h;h=2856fd8388343495fa1ce21b1b03609df2f85d7c;hb=d583ad46d4babd962f362deac20fa5aa6cdce7c7;hp=9649b177660124bba8812de51f49667ce7d3ac9f;hpb=fd9eec78a3c275401d4b661a49cd90b972c9f58d;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_server_lib.h b/src/include/gnunet_server_lib.h index 9649b1776..2856fd838 100644 --- a/src/include/gnunet_server_lib.h +++ b/src/include/gnunet_server_lib.h @@ -38,7 +38,6 @@ extern "C" #include "gnunet_common.h" #include "gnunet_connection_lib.h" -#include "gnunet_scheduler_lib.h" /** @@ -46,6 +45,10 @@ extern "C" */ #define GNUNET_SERVER_MAX_MESSAGE_SIZE 65536 +/** + * Smallest supported message. + */ +#define GNUNET_SERVER_MIN_BUFFER_SIZE sizeof (struct GNUNET_MessageHeader) /** * @brief handle for a server @@ -70,9 +73,8 @@ struct GNUNET_SERVER_Client; typedef void (*GNUNET_SERVER_MessageCallback) (void *cls, struct GNUNET_SERVER_Client * client, - const struct - GNUNET_MessageHeader * - message); + const struct GNUNET_MessageHeader + * message); @@ -111,11 +113,9 @@ struct GNUNET_SERVER_MessageHandler /** * Create a new server. * - * @param sched scheduler to use * @param access function for access control * @param access_cls closure for access * @param lsocks NULL-terminated array of listen sockets - * @param maxbuf maximum write buffer size for accepted sockets * @param idle_timeout after how long should we timeout idle connections? * @param require_found if YES, connections sending messages of unknown type * will be closed @@ -123,40 +123,31 @@ struct GNUNET_SERVER_MessageHandler * (typically, "port" already in use) */ struct GNUNET_SERVER_Handle * -GNUNET_SERVER_create_with_sockets (struct GNUNET_SCHEDULER_Handle *sched, - GNUNET_CONNECTION_AccessCheck access, void *access_cls, - struct GNUNET_NETWORK_Handle **lsocks, - size_t maxbuf, - struct GNUNET_TIME_Relative - idle_timeout, - int require_found); +GNUNET_SERVER_create_with_sockets (GNUNET_CONNECTION_AccessCheck access, + void *access_cls, + struct GNUNET_NETWORK_Handle **lsocks, + struct GNUNET_TIME_Relative idle_timeout, + int require_found); /** * Create a new server. * - * @param sched scheduler to use * @param access function for access control * @param access_cls closure for access * @param serverAddr address toes listen on (including port), NULL terminated array - * @param socklen lengths of respective serverAddr - * @param maxbuf maximum write buffer size for accepted sockets + * @param socklen lengths of respective serverAddr * @param idle_timeout after how long should we timeout idle connections? * @param require_found if YES, connections sending messages of unknown type * will be closed * @return handle for the new server, NULL on error * (typically, "port" already in use) */ -struct GNUNET_SERVER_Handle *GNUNET_SERVER_create (struct - GNUNET_SCHEDULER_Handle - *sched, - GNUNET_CONNECTION_AccessCheck - access, void *access_cls, - struct sockaddr *const*serverAddr, - const socklen_t *socklen, - size_t maxbuf, - struct GNUNET_TIME_Relative - idle_timeout, - int require_found); +struct GNUNET_SERVER_Handle * +GNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access, void *access_cls, + struct sockaddr *const *serverAddr, + const socklen_t * socklen, + struct GNUNET_TIME_Relative idle_timeout, + int require_found); /** @@ -164,7 +155,8 @@ struct GNUNET_SERVER_Handle *GNUNET_SERVER_create (struct * * @param s server to destroy */ -void GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *s); +void +GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *s); /** @@ -201,12 +193,12 @@ GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server, * GNUNET_CONNECTION_notify_transmit_ready_cancel. * NULL if we are already going to notify someone else (busy) */ -struct GNUNET_CONNECTION_TransmitHandle - *GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client, - size_t size, - struct GNUNET_TIME_Relative timeout, - GNUNET_CONNECTION_TransmitReadyNotify - callback, void *callback_cls); +struct GNUNET_CONNECTION_TransmitHandle * +GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client, + size_t size, + struct GNUNET_TIME_Relative timeout, + GNUNET_CONNECTION_TransmitReadyNotify + callback, void *callback_cls); /** @@ -234,6 +226,31 @@ void GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client, int success); +/** + * Change the timeout for a particular client. Decreasing the timeout + * may not go into effect immediately (only after the previous timeout + * times out or activity happens on the socket). + * + * @param client the client to update + * @param timeout new timeout for activities on the socket + */ +void +GNUNET_SERVER_client_set_timeout (struct GNUNET_SERVER_Client *client, + struct GNUNET_TIME_Relative timeout); + + +/** + * Disable the warning the server issues if a message is not acknowledged + * in a timely fashion. Use this call if a client is intentionally delayed + * for a while. Only applies to the current message. + * + * @param client client for which to disable the warning + */ +void +GNUNET_SERVER_disable_receive_done_warning (struct GNUNET_SERVER_Client + *client); + + /** * Inject a message into the server, pretend it came * from the specified client. Delivery of the message @@ -267,12 +284,9 @@ GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server, * @return the client handle (client should call * "client_drop" on the return value eventually) */ -struct GNUNET_SERVER_Client *GNUNET_SERVER_connect_socket (struct - GNUNET_SERVER_Handle - *server, - struct - GNUNET_CONNECTION_Handle - *connection); +struct GNUNET_SERVER_Client * +GNUNET_SERVER_connect_socket (struct GNUNET_SERVER_Handle *server, + struct GNUNET_CONNECTION_Handle *connection); /** @@ -282,7 +296,8 @@ struct GNUNET_SERVER_Client *GNUNET_SERVER_connect_socket (struct * * @param client the client to keep */ -void GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client); +void +GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client); /** @@ -293,7 +308,8 @@ void GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client); * * @param client the client to drop */ -void GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client); +void +GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client); /** @@ -304,8 +320,9 @@ void GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client); * @param addrlen where to store the length of the address * @return GNUNET_OK on success */ -int GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client, - void **addr, size_t * addrlen); +int +GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client, + void **addr, size_t * addrlen); /** @@ -317,15 +334,15 @@ int GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client, * for the last call when the server is destroyed */ typedef void (*GNUNET_SERVER_DisconnectCallback) (void *cls, - struct GNUNET_SERVER_Client - * client); + struct GNUNET_SERVER_Client * + client); /** * Ask the server to notify us whenever a client disconnects. * This function is called whenever the actual network connection * is closed; the reference count may be zero or larger than zero - * at this point. If the server is destroyed before this + * at this point. If the server is destroyed before this * notification is explicitly cancelled, the 'callback' will * once be called with a 'client' argument of NULL to indicate * that the server itself is now gone (and that the callback @@ -335,9 +352,10 @@ typedef void (*GNUNET_SERVER_DisconnectCallback) (void *cls, * @param callback function to call on disconnect * @param callback_cls closure for callback */ -void GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server, - GNUNET_SERVER_DisconnectCallback - callback, void *callback_cls); +void +GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server, + GNUNET_SERVER_DisconnectCallback callback, + void *callback_cls); /** @@ -347,9 +365,10 @@ void GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server, * @param callback function to call on disconnect * @param callback_cls closure for callback */ -void GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server, - GNUNET_SERVER_DisconnectCallback - callback, void *callback_cls); +void +GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server, + GNUNET_SERVER_DisconnectCallback + callback, void *callback_cls); /** @@ -360,7 +379,8 @@ void GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server * * @param client the client to disconnect from */ -void GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client); +void +GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client); /** @@ -375,11 +395,22 @@ void GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client); * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default */ void -GNUNET_SERVER_ignore_shutdown (struct GNUNET_SERVER_Handle *h, - int do_ignore); +GNUNET_SERVER_ignore_shutdown (struct GNUNET_SERVER_Handle *h, int do_ignore); +/** + * Disable the "CORK" feature for communication with the given client, + * forcing the OS to immediately flush the buffer on transmission + * instead of potentially buffering multiple messages. + * + * @param client handle to the client + * @return GNUNET_OK on success + */ +int +GNUNET_SERVER_client_disable_corking (struct GNUNET_SERVER_Client *client); + + /** * The tansmit context is the key datastructure for a conveniance API * used for transmission of complex results to the client followed @@ -395,9 +426,8 @@ struct GNUNET_SERVER_TransmitContext; * @param client client to create the context for. * @return NULL on error */ -struct GNUNET_SERVER_TransmitContext - *GNUNET_SERVER_transmit_context_create (struct GNUNET_SERVER_Client - *client); +struct GNUNET_SERVER_TransmitContext * +GNUNET_SERVER_transmit_context_create (struct GNUNET_SERVER_Client *client); /** @@ -412,8 +442,8 @@ struct GNUNET_SERVER_TransmitContext */ void GNUNET_SERVER_transmit_context_append_data (struct GNUNET_SERVER_TransmitContext - *tc, const void *data, size_t length, - uint16_t type); + *tc, const void *data, + size_t length, uint16_t type); /** @@ -425,15 +455,17 @@ GNUNET_SERVER_transmit_context_append_data (struct GNUNET_SERVER_TransmitContext * @param msg message to append */ void -GNUNET_SERVER_transmit_context_append_message (struct GNUNET_SERVER_TransmitContext - *tc, const struct GNUNET_MessageHeader *msg); +GNUNET_SERVER_transmit_context_append_message (struct + GNUNET_SERVER_TransmitContext + *tc, + const struct GNUNET_MessageHeader + *msg); /** - * Execute a transmission context. If there is - * an error in the transmission, the receive_done - * method will be called with an error code (GNUNET_SYSERR), - * otherwise with GNUNET_OK. + * Execute a transmission context. If there is an error in the + * transmission, the receive_done method will be called with an error + * code (GNUNET_SYSERR), otherwise with GNUNET_OK. * * @param tc transmission context to use * @param timeout when to time out and abort the transmission @@ -443,6 +475,22 @@ GNUNET_SERVER_transmit_context_run (struct GNUNET_SERVER_TransmitContext *tc, struct GNUNET_TIME_Relative timeout); +/** + * Destroy a transmission context. This function must not be called + * after 'GNUNET_SERVER_transmit_context_run'. + * + * @param tc transmission context to destroy + * @param success code to give to 'GNUNET_SERVER_receive_done' for + * the client: GNUNET_OK to keep the connection open and + * continue to receive + * GNUNET_NO to close the connection (normal behavior) + * GNUNET_SYSERR to close the connection (signal + * serious error) + */ +void +GNUNET_SERVER_transmit_context_destroy (struct GNUNET_SERVER_TransmitContext + *tc, int success); + /** * The notification context is the key datastructure for a conveniance @@ -461,12 +509,12 @@ struct GNUNET_SERVER_NotificationContext; * @param server server for which this function creates the context * @param queue_length maximum number of messages to keep in * the notification queue; optional messages are dropped - * it the queue gets longer than this number of messages + * if the queue gets longer than this number of messages * @return handle to the notification context */ struct GNUNET_SERVER_NotificationContext * GNUNET_SERVER_notification_context_create (struct GNUNET_SERVER_Handle *server, - unsigned int queue_length); + unsigned int queue_length); /** @@ -475,7 +523,9 @@ GNUNET_SERVER_notification_context_create (struct GNUNET_SERVER_Handle *server, * @param nc context to destroy. */ void -GNUNET_SERVER_notification_context_destroy (struct GNUNET_SERVER_NotificationContext *nc); +GNUNET_SERVER_notification_context_destroy (struct + GNUNET_SERVER_NotificationContext + *nc); /** @@ -485,8 +535,9 @@ GNUNET_SERVER_notification_context_destroy (struct GNUNET_SERVER_NotificationCon * @param client client to add */ void -GNUNET_SERVER_notification_context_add (struct GNUNET_SERVER_NotificationContext *nc, - struct GNUNET_SERVER_Client *client); +GNUNET_SERVER_notification_context_add (struct GNUNET_SERVER_NotificationContext + *nc, + struct GNUNET_SERVER_Client *client); /** @@ -499,10 +550,12 @@ GNUNET_SERVER_notification_context_add (struct GNUNET_SERVER_NotificationContext * @param can_drop can this message be dropped due to queue length limitations */ void -GNUNET_SERVER_notification_context_unicast (struct GNUNET_SERVER_NotificationContext *nc, - struct GNUNET_SERVER_Client *client, - const struct GNUNET_MessageHeader *msg, - int can_drop); +GNUNET_SERVER_notification_context_unicast (struct + GNUNET_SERVER_NotificationContext + *nc, + struct GNUNET_SERVER_Client *client, + const struct GNUNET_MessageHeader + *msg, int can_drop); /** @@ -513,9 +566,11 @@ GNUNET_SERVER_notification_context_unicast (struct GNUNET_SERVER_NotificationCon * @param can_drop can this message be dropped due to queue length limitations */ void -GNUNET_SERVER_notification_context_broadcast (struct GNUNET_SERVER_NotificationContext *nc, - const struct GNUNET_MessageHeader *msg, - int can_drop); +GNUNET_SERVER_notification_context_broadcast (struct + GNUNET_SERVER_NotificationContext + *nc, + const struct GNUNET_MessageHeader + *msg, int can_drop); @@ -532,28 +587,22 @@ struct GNUNET_SERVER_MessageStreamTokenizer; * @param client identification of the client * @param message the actual message */ -typedef void (*GNUNET_SERVER_MessageTokenizerCallback) (void *cls, - void *client, - const struct - GNUNET_MessageHeader * - message); +typedef void (*GNUNET_SERVER_MessageTokenizerCallback) (void *cls, void *client, + const struct + GNUNET_MessageHeader * + message); /** * Create a message stream tokenizer. * - * @param maxbuf maximum message size to support (typically - * GNUNET_SERVER_MAX_MESSAGE_SIZE) - * @param client_identity ID of client for which this is a buffer, - * can be NULL (will be passed back to 'cb') * @param cb function to call on completed messages * @param cb_cls closure for cb * @return handle to tokenizer */ struct GNUNET_SERVER_MessageStreamTokenizer * -GNUNET_SERVER_mst_create (size_t maxbuf, - GNUNET_SERVER_MessageTokenizerCallback cb, - void *cb_cls); +GNUNET_SERVER_mst_create (GNUNET_SERVER_MessageTokenizerCallback cb, + void *cb_cls); /** @@ -561,9 +610,11 @@ GNUNET_SERVER_mst_create (size_t maxbuf, * callback for all complete messages. * * @param mst tokenizer to use + * @param client_identity ID of client for which this is a buffer, + * can be NULL (will be passed back to 'cb') * @param buf input data to add * @param size number of bytes in buf - * @param purge should any excess bytes in the buffer be discarded + * @param purge should any excess bytes in the buffer be discarded * (i.e. for packet-based services like UDP) * @param one_shot only call callback once, keep rest of message in buffer * @return GNUNET_OK if we are done processing (need more data) @@ -572,11 +623,8 @@ GNUNET_SERVER_mst_create (size_t maxbuf, */ int GNUNET_SERVER_mst_receive (struct GNUNET_SERVER_MessageStreamTokenizer *mst, - void *client_identity, - const char *buf, - size_t size, - int purge, - int one_shot); + void *client_identity, const char *buf, size_t size, + int purge, int one_shot); /**