libevent

include/event2/bufferevent_struct.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2000-2007 Niels Provos <provos@citi.umich.edu>
00003  * Copyright (c) 2007-2010 Niels Provos and Nick Mathewson
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. The name of the author may not be used to endorse or promote products
00014  *    derived from this software without specific prior written permission.
00015  *
00016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00017  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00018  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00019  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00020  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00021  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00022  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00023  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00024  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00025  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026  */
00027 #ifndef _EVENT2_BUFFEREVENT_STRUCT_H_
00028 #define _EVENT2_BUFFEREVENT_STRUCT_H_
00029 
00037 #ifdef __cplusplus
00038 extern "C" {
00039 #endif
00040 
00041 #include <event2/event-config.h>
00042 #ifdef _EVENT_HAVE_SYS_TYPES_H
00043 #include <sys/types.h>
00044 #endif
00045 #ifdef _EVENT_HAVE_SYS_TIME_H
00046 #include <sys/time.h>
00047 #endif
00048 
00049 /* For int types. */
00050 #include <event2/util.h>
00051 /* For struct event */
00052 #include <event2/event_struct.h>
00053 
00054 struct event_watermark {
00055         size_t low;
00056         size_t high;
00057 };
00058 
00067 struct bufferevent {
00069         struct event_base *ev_base;
00072         const struct bufferevent_ops *be_ops;
00073 
00077         struct event ev_read;
00081         struct event ev_write;
00082 
00085         struct evbuffer *input;
00086 
00089         struct evbuffer *output;
00090 
00091         struct event_watermark wm_read;
00092         struct event_watermark wm_write;
00093 
00094         bufferevent_data_cb readcb;
00095         bufferevent_data_cb writecb;
00096         /* This should be called 'eventcb', but renaming it would break
00097          * backward compatibility */
00098         bufferevent_event_cb errorcb;
00099         void *cbarg;
00100 
00101         struct timeval timeout_read;
00102         struct timeval timeout_write;
00103 
00106         short enabled;
00107 };
00108 
00109 #ifdef __cplusplus
00110 }
00111 #endif
00112 
00113 #endif /* _EVENT2_BUFFEREVENT_STRUCT_H_ */
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines