src/transport_fd.h
branchnew-transport
changeset 165 b3e95108c884
parent 159 d3e253d7281a
child 176 6750d50ee8cd
--- a/src/transport_fd.h	Sun May 03 17:16:30 2009 +0300
+++ b/src/transport_fd.h	Sun May 03 17:18:16 2009 +0300
@@ -6,7 +6,7 @@
  *
  * Support for transport implementations that use POSIX file descriptor streams.
  *
- * This provides the read/write methods, as well as functions to help implement the event-based behaviour
+ * This provides the read/write methods, as well as functions to implement the event-based behaviour.
  */
 #include "transport_internal.h"
 
@@ -96,7 +96,7 @@
  * Initialize the transport_fd to use the given, connected fd, or TRANSPORT_FD_INVALID if we don't yet have an fd.
  *
  * It is an error to call this if the transport_fd already has an fd set
- i*
+ *
  * @param fd the transport_fd state
  * @param ev_base the libevent base to use
  * @param _fd the OS file descriptor, or TRANSPORT_FD_INVALID
@@ -121,7 +121,7 @@
 err_t transport_fd_enable (struct transport_fd *fd, short mask);
 
 /**
- * Disable the specifid events, any of { TRANSPORT_READ, TRANSPORT_WRITE }.
+ * Disable the specified events, any of { TRANSPORT_READ, TRANSPORT_WRITE }.
  */
 err_t transport_fd_disable (struct transport_fd *fd, short mask);
 
@@ -150,17 +150,16 @@
 err_t transport_fd_set (struct transport_fd *fd, int _fd);
 
 /**
- * Invoke the transport_callbacks based on the given mask of libevent EV_* bits
- */
-void transport_fd_invoke (struct transport_fd *fd, short what);
-
-/**
  * Close an opened fd, releasing all resources within our state.
  */
 err_t transport_fd_close (struct transport_fd *fd);
 
 /**
  * Destroy the fd immediately.
+ *
+ * This logs a warning if the close() fails.
+ *
+ * XXX: this may actually block, I think? SO_LINGER?
  */
 void transport_fd_destroy (struct transport_fd *fd);