Wrapper around a libevent event owned by an EventBase backend.

Synopsis

Declared in <folly/io/async/EventBaseBackendBase.h>

class EventBaseEvent;

Type Aliases

Name

Description

FreeFunction

Callback type used to free the event's user data.

Member Functions

Name

Description

EventBaseEvent [constructor]

Constructors

~EventBaseEvent [destructor]

Frees any user data still owned by the event.

operator= [deleted]

Deleted copy assignment.

eb_ev_base

eb_ev_base overloads

eb_ev_events

Returns the event flags of the event.

eb_ev_fd

Returns the file descriptor of the event.

eb_ev_res

Returns the result flags of the event.

eb_event_active

Marks the event as active with the given result flags.

eb_event_add

Adds the event to its EventBase, optionally with a timeout.

eb_event_base_set

Associates the event with the given EventBase.

eb_event_del

Removes the event from its EventBase.

eb_event_set

Configures the event for a file descriptor and callback.

eb_signal_set

Configures the event as a persistent signal handler.

eb_timer_set

Configures the event as a timer.

getEvent

Returns the underlying libevent event.

getFreeFunction

Returns the free function for the event's user data.

getUserData

Returns the user data pointer attached to the event.

isEventRegistered

Returns whether the event is currently registered.

setEdgeTriggered

Enables edge‐triggered mode for the event.

setUserData

setUserData overloads

Protected Member Functions

Name

Description

getBackend

Returns the backend that owns this event.

Protected Data Members

Name

Description

evb_

The EventBase that owns this event.

event_

The underlying libevent event.

freeFn_

The function used to free the user data.

userData_

The user data pointer attached to the event.

Created with MrDocs