Permalink
Browse files

Typo and formatting fixes

  • Loading branch information...
Frank Schoep authored and nmathewson committed Jan 31, 2012
1 parent dd98db7 commit 775ae0f71d114d5763217b8f78eb2dc98f133c2d
Showing with 43 additions and 29 deletions.
  1. +42 −28 Ref2_eventbase.txt
  2. +1 −1 TOC.txt
View
@@ -107,37 +107,51 @@ the run-time flags below when constructing the event base.
The recognized feature values for event_config_require_features are:
-- EV_FEATURE_ET: Requires a backend method that supports edge-triggered IO.
-- EV_FEATURE_O1: Requires a backend method where adding or deleting a single
- event, or having a single event become active, is an O(1) operation.
-- EV_FEATURE_FDS: Requires a backend method that can support arbitrary file
- descriptor types, and not just sockets.
+EV_FEATURE_ET::
+ Requires a backend method that supports edge-triggered IO.
+
+EV_FEATURE_O1::
+ Requires a backend method where adding or deleting a single
+ event, or having a single event become active, is an O(1) operation.
+
+EV_FEATURE_FDS::
+ Requires a backend method that can support arbitrary file
+ descriptor types, and not just sockets.
The recognized option values for event_config_set_flag() are:
-- EVENT_BASE_FLAG_NOLOCK: Do not allocate locks for the event_base. Setting
- this option may save a little time for locking and releasing the
- event_base, but will make it unsafe to access it from multiple threads.
-- EVENT_BASE_FLAG_IGNORE_ENV: Do not check the EVENT_* environment
- variables when picking which backend method to use. Think hard before
- using this flag: it can make it harder for users to debug the interactions
- between your program and Libevent.
-- EVENT_BASE_FLAG_STARTUP_IOCP: On Window only, this flag makes Libevent
- enable any necessary IOCP dispatch logic on startup, rather than
- on-demand.
-- EVENT_BASE_FLAG_NO_CACHE_TIME: Instead of checking the current time every
- time the event loop is ready to run timeout callbacks, check it after
- every timeout callback. This can use more CPU than you necessarily
- intended, so watch out!
-- EVENT_BASE_FLAG_EPOLL_USE_CHANGELIST: Tells Libevent that, if it decides to
- use the epoll backend, it is safe to use the faster "changelist"-based
- backend. The epoll-changelist backend can avoid needless system calls in
- cases where the same fd has its status modified more than once between
- calls to the backend's dispatch function, but it also trigger a kernel bug
- that causes erroneous results if you give Libevent any fds cloned by
- dup() or its variants. This flag has no effect if you use a backend
- other than epoll. You can also turn on the epoll-changelist option by
- setting the EVENT_EPOLL_uSE_CHANGELIST environment variable.
+EVENT_BASE_FLAG_NOLOCK::
+ Do not allocate locks for the event_base. Setting
+ this option may save a little time for locking and releasing the
+ event_base, but will make it unsafe to access it from multiple threads.
+
+EVENT_BASE_FLAG_IGNORE_ENV::
+ Do not check the EVENT_* environment
+ variables when picking which backend method to use. Think hard before
+ using this flag: it can make it harder for users to debug the interactions
+ between your program and Libevent.
+
+EVENT_BASE_FLAG_STARTUP_IOCP::
+ On Window only, this flag makes Libevent
+ enable any necessary IOCP dispatch logic on startup, rather than
+ on-demand.
+
+EVENT_BASE_FLAG_NO_CACHE_TIME::
+ Instead of checking the current time every
+ time the event loop is ready to run timeout callbacks, check it after
+ every timeout callback. This can use more CPU than you necessarily
+ intended, so watch out!
+
+EVENT_BASE_FLAG_EPOLL_USE_CHANGELIST::
+ Tells Libevent that, if it decides to
+ use the epoll backend, it is safe to use the faster "changelist"-based
+ backend. The epoll-changelist backend can avoid needless system calls in
+ cases where the same fd has its status modified more than once between
+ calls to the backend's dispatch function, but it also trigger a kernel bug
+ that causes erroneous results if you give Libevent any fds cloned by
+ dup() or its variants. This flag has no effect if you use a backend
+ other than epoll. You can also turn on the epoll-changelist option by
+ setting the EVENT_EPOLL_uSE_CHANGELIST environment variable.
The above functions that manipulate an event_config all return 0 on success,
-1 on failure.
View
@@ -16,7 +16,7 @@ A Libevent Reference Manual
- link:Ref2_eventbase.html[R2: Getting an event_base]
- link:Ref3_eventloop.html[R3: Running an event loop]
- link:Ref4_event.html[R4: Working with events]
-- link:Ref5_evutil.html[R5: Utiltity and portability functions]
+- link:Ref5_evutil.html[R5: Utility and portability functions]
- link:Ref6_bufferevent.html[R6: Bufferevents: concepts and basics]
- link:Ref6a_advanced_bufferevents.html[R6a: Bufferevents: advanced topics]
- link:Ref7_evbuffer.html[R7: Evbuffers: utility functionality for buffered IO]

0 comments on commit 775ae0f

Please sign in to comment.