![]() |
![]() |
![]() |
libinfinity-0.4 Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Prerequisites | Known Implementations |
#include <libinfinity/common/inf-io.h> InfIo; InfIoIface; typedef InfNativeSocket; enum InfIoEvent; void (*InfIoFunc) (InfNativeSocket *socket, InfIoEvent event, gpointer user_data); void (*InfIoTimeoutFunc) (gpointer user_data); void inf_io_watch (InfIo *io, InfNativeSocket *socket, InfIoEvent events, InfIoFunc func, gpointer user_data, GDestroyNotify notify); gpointer inf_io_add_timeout (InfIo *io, guint msecs, InfIoTimeoutFunc func, gpointer user_data, GDestroyNotify notify); void inf_io_remove_timeout (InfIo *io, gpointer timeout);
The InfIo interface is used to schedule timeouts and to watch sockets for events to occur. An actual implementation usually integrates this into the application main loop, such as GMainLoop. There is also a standalone implementation, InfStandaloneIo, that can directly be used as the application's main loop.
Every object in Libinfinity that needs to schedule timeouts or watches sockets uses a InfIo to do so. This allows to use libinfinity with different main event loops, not only Glib's one.
typedef struct _InfIo InfIo;
InfIo is an opaque data type. You should only access it via the public API functions.
typedef struct { void (*watch)(InfIo* io, InfNativeSocket* socket, InfIoEvent events, InfIoFunc func, gpointer user_data, GDestroyNotify notify); gpointer (*add_timeout)(InfIo* io, guint msecs, InfIoTimeoutFunc func, gpointer user_data, GDestroyNotify notify); void (*remove_timeout)(InfIo* io, gpointer timeout); } InfIoIface;
The virtual methods of InfIo. These allow to set up socket watches and timeouts.
|
Changes the events the given socket is watched for. If events is
0, removes the watch for socket .
|
|
Schedules func to be called at least msecs milliseconds
in the future.
|
|
Removes a scheduled timeout again. The timeout is removed automatically when it has elapsed, so there is no need to call this function in that case. |
Native socket type on the target platform. This typedef is a simple int on Unix and a SOCKET on Windows.
typedef enum _InfIoEvent { INF_IO_INCOMING = 1 << 0, INF_IO_OUTGOING = 1 << 1, INF_IO_ERROR = 1 << 2 } InfIoEvent;
This enumeration specifies events that can be watched.
Data can be read from the socket without blocking, or
the connection has been closed (which is the case when recv() returns 0).
|
|
Data can be sent without blocking. | |
An error with the socket occured, or the connection has
been closed. Use getsockopt() to read do SO_ERROR option to find out what
the problem is.
|
void (*InfIoFunc) (InfNativeSocket *socket, InfIoEvent event, gpointer user_data);
Callback function that is called when an event occurs on a watched socket.
|
The socket on which an event occured. |
|
A bitmask of the events that occured. |
|
User-defined data specified in inf_io_watch() .
|
void (*InfIoTimeoutFunc) (gpointer user_data);
Callback function that is called when a timeout has elapsed.
|
User-defined data specified in inf_io_add_timeout() .
|
void inf_io_watch (InfIo *io, InfNativeSocket *socket, InfIoEvent events, InfIoFunc func, gpointer user_data, GDestroyNotify notify);
Monitors the given socket for activity and calls func
if one of the
events specified in events
occurs.
|
A InfIo. |
|
The socket to watch. |
|
Events to watch for. |
|
Function to be called when one of the events occurs. |
|
Extra data to pass to func .
|
|
A GDestroyNotify that is called when user_data is no longer
needed, or NULL .
|
gpointer inf_io_add_timeout (InfIo *io, guint msecs, InfIoTimeoutFunc func, gpointer user_data, GDestroyNotify notify);
Calls func
after at least msecs
milliseconds have elapsed. The timeout
is removed after it has elapsed.
|
A InfIo. |
|
Number of milliseconds after which the timeout should be elapsed. |
|
Function to be called when the timeout elapsed. |
|
Extra data to pass to func .
|
|
A GDestroyNotify that is called when user_data is no longer
needed, or NULL .
|
Returns : |
A timeout handle that can be used to remove the timeout. |
void inf_io_remove_timeout (InfIo *io, gpointer timeout);
Removes the given timeout.
|
A InfIo. |
|
A timeout handle obtained from inf_io_add_timeout() .
|