OpenMPI  0.1.1
bufferevent Struct Reference

Shared implementation of a bufferevent. More...

#include <bufferevent_struct.h>

Data Fields

struct event_baseev_base
 Event base for which this bufferevent was created. More...
 
const struct bufferevent_opsbe_ops
 Pointer to a table of function pointers to set up how this bufferevent behaves. More...
 
struct event ev_read
 A read event that triggers when a timeout has happened or a socket is ready to read data. More...
 
struct event ev_write
 A write event that triggers when a timeout has happened or a socket is ready to write data. More...
 
struct evbufferinput
 An input buffer. More...
 
struct evbufferoutput
 An input buffer. More...
 
struct event_watermark wm_read
 
struct event_watermark wm_write
 
bufferevent_data_cb readcb
 
bufferevent_data_cb writecb
 
bufferevent_event_cb errorcb
 
void * cbarg
 
struct timeval timeout_read
 
struct timeval timeout_write
 
short enabled
 Events that are currently enabled: currently EV_READ and EV_WRITE are supported. More...
 

Detailed Description

Shared implementation of a bufferevent.

This type is exposed only because it was exposed in previous versions, and some people's code may rely on manipulating it. Otherwise, you should really not rely on the layout, size, or contents of this structure: it is fairly volatile, and WILL change in future versions of the code.

Field Documentation

const struct bufferevent_ops* bufferevent::be_ops
short bufferevent::enabled

Events that are currently enabled: currently EV_READ and EV_WRITE are supported.

Referenced by bufferevent_disable(), bufferevent_enable(), and bufferevent_get_enabled().

struct event bufferevent::ev_read

A read event that triggers when a timeout has happened or a socket is ready to read data.

Only used by some subtypes of bufferevent.

Referenced by bufferevent_base_set(), bufferevent_priority_set(), and bufferevent_socket_new().

struct event bufferevent::ev_write

A write event that triggers when a timeout has happened or a socket is ready to write data.

Only used by some subtypes of bufferevent.

Referenced by bufferevent_base_set(), bufferevent_priority_set(), bufferevent_socket_connect(), and bufferevent_socket_new().

struct evbuffer* bufferevent::input

An input buffer.

Only the bufferevent is allowed to add data to this buffer, though the user is allowed to drain it.

Referenced by bufferevent_get_input(), bufferevent_read(), bufferevent_read_buffer(), bufferevent_setwatermark(), and bufferevent_socket_new().

struct evbuffer* bufferevent::output

An input buffer.

Only the bufferevent is allowed to drain data from this buffer, though the user is allowed to add it.

Referenced by bufferevent_get_output(), bufferevent_socket_new(), bufferevent_write(), and bufferevent_write_buffer().


The documentation for this struct was generated from the following file: