glibmm  2.76.0
Public Member Functions | List of all members
Glib::SignalIO Class Reference

#include <glibmm/main.h>

Public Member Functions

sigc::connection connect (const sigc::slot< bool(IOCondition)> & slot, PollFD::fd_t fd, IOCondition condition, int priority=PRIORITY_DEFAULT)
 Connects an I/O handler that watches a file descriptor. More...
 
sigc::connection connect (const sigc::slot< bool(IOCondition)> & slot, const Glib::RefPtr< IOChannel > & channel, IOCondition condition, int priority=PRIORITY_DEFAULT)
 Connects an I/O handler that watches an I/O channel. More...
 

Member Function Documentation

◆ connect() [1/2]

sigc::connection Glib::SignalIO::connect ( const sigc::slot< bool(IOCondition)> &  slot,
const Glib::RefPtr< IOChannel > &  channel,
IOCondition  condition,
int  priority = PRIORITY_DEFAULT 
)

Connects an I/O handler that watches an I/O channel.

bool io_handler(Glib::IOCondition io_condition) { ... }
Glib::signal_io().connect(sigc::ptr_fun(&io_handler), channel, Glib::IO_IN | Glib::IO_HUP);
pointer_to_unary_function< _Arg, _Result > ptr_fun(_Result(*__x)(_Arg))
sigc::connection connect(const sigc::slot< bool(IOCondition)> &slot, PollFD::fd_t fd, IOCondition condition, int priority=PRIORITY_DEFAULT)
Connects an I/O handler that watches a file descriptor.
SignalIO signal_io()
Convenience I/O signal.
IOCondition
A bitwise combination representing an I/O condition to watch for on an event source.
Definition: iochannel.h:245

is equivalent to:

bool io_handler(Glib::IOCondition io_condition) { ... }
const auto io_source = Glib::IOSource::create(channel, Glib::IO_IN | Glib::IO_HUP);
io_source->connect(sigc::ptr_fun(&io_handler));
io_source->attach(Glib::MainContext::get_default());
static Glib::RefPtr< MainContext > get_default()
Returns the global default main context.
static Glib::RefPtr< Source > create()

This method is not thread-safe. You should call it, or manipulate the returned sigc::connection object, only from the thread where the SignalIO object's MainContext runs.

Parameters
slotA slot to call when polling channel results in an event that matches condition. The event will be passed as a parameter to slot. If io_handler() returns false the handler is disconnected.
channelThe IOChannel object to watch.
conditionThe conditions to watch for.
priorityThe priority of the new event source.
Returns
A connection handle, which can be used to disconnect the handler.

◆ connect() [2/2]

sigc::connection Glib::SignalIO::connect ( const sigc::slot< bool(IOCondition)> &  slot,
PollFD::fd_t  fd,
IOCondition  condition,
int  priority = PRIORITY_DEFAULT 
)

Connects an I/O handler that watches a file descriptor.

bool io_handler(Glib::IOCondition io_condition) { ... }
Glib::signal_io().connect(sigc::ptr_fun(&io_handler), fd, Glib::IO_IN | Glib::IO_HUP);

is equivalent to:

bool io_handler(Glib::IOCondition io_condition) { ... }
const auto io_source = Glib::IOSource::create(fd, Glib::IO_IN | Glib::IO_HUP);
io_source->connect(sigc::ptr_fun(&io_handler));
io_source->attach(Glib::MainContext::get_default());

This method is not thread-safe. You should call it, or manipulate the returned sigc::connection object, only from the thread where the SignalIO object's MainContext runs.

Parameters
slotA slot to call when polling fd results in an event that matches condition. The event will be passed as a parameter to slot. If io_handler() returns false the handler is disconnected.
fdThe file descriptor (or a HANDLE on Win32 systems) to watch.
conditionThe conditions to watch for.
priorityThe priority of the new event source.
Returns
A connection handle, which can be used to disconnect the handler.