Efl.Net.Dialer (interface)

Description

Creates a client socket to reach a remote peer.

The connection process starts when Efl.Net.Dialer.dial is executed. This allows implementations to request more complex setups requiring a live object handle, which is not possible during construction.

The socket should be considered connected and ready to use only when "connected" event is dispatched. By then Efl.Io.Reader.can_read and Efl.Io.Writer.can_write should change accordingly.

Once the socket is closed, Efl.Io.Closer.closed will be called and the "closed" event is dispatched.

Since 1.19

Inheritance

Efl.Net.Socket (interface)Efl.Io.Reader (interface)

Full hierarchy

Members

address_dial (get, set) protected set

Returns the address given to Efl.Net.Dialer.dial.
const char *efl_net_dialer_address_dial_get(const Eo *obj);
void efl_net_dialer_address_dial_set(Eo *obj, const char *address);


connected (get, set) protected set

Returns whenever the socket is connected or not.
Eina_Bool efl_net_dialer_connected_get(const Eo *obj);
void efl_net_dialer_connected_set(Eo *obj, Eina_Bool connected);


dial

Dials to the remote peer.
Eina_Error efl_net_dialer_dial(Eo *obj, const char *address);


proxy (get, set)

Controls/retrieves if the dialer should use a proxy.
const char *efl_net_dialer_proxy_get(const Eo *obj);
void efl_net_dialer_proxy_set(Eo *obj, const char *proxy_url);


timeout_dial (get, set)

The timeout in seconds to use for dialing/connecting.
double efl_net_dialer_timeout_dial_get(const Eo *obj);
void efl_net_dialer_timeout_dial_set(Eo *obj, double seconds);


Inherited

Efl.Io.Closer
close Closes the Input/Output object.
close_on_destructor (get, set) If true will automatically close() on object destructor.
close_on_exec (get, set) If true will automatically close resources on exec() calls.
closed (get, set) If true will notify object was closed.
Efl.Io.Reader
protected set can_read (get, set) If true will notify Efl.Io.Reader.read can be called without blocking or failing.
protected set eos (get, set) If true will notify end of stream.
read Reads data into a pre-allocated buffer.
Efl.Io.Writer
protected set can_write (get, set) If true will notify Efl.Io.Writer.write can be called without blocking or failing.
write Writes data from a pre-populated buffer.
Efl.Net.Socket
protected set address_local (get, set) The local address, similar to getsockname().
protected set address_remote (get, set) The remote address, similar to getpeername().

Events

connected

Notifies the socket is connected to the remote peer.
EFL_NET_DIALER_EVENT_CONNECTED(void)


error

Some error happened and the socket stopped working.
EFL_NET_DIALER_EVENT_ERROR(Eina_Error)


resolved

EFL_NET_DIALER_EVENT_RESOLVED(const char *)


Inherited

Efl.Io.Closer
closed Notifies closed, when property is marked as true
Efl.Io.Reader
can_read,changed Notifies can_read property changed.
eos Notifies end of stream, when property is marked as true.
Efl.Io.Writer
can_write,changed Notifies can_write property changed.