Trait gio::prelude::SocketListenerExt [−][src]
pub trait SocketListenerExt: 'static {}Show methods
fn accept<P: IsA<Cancellable>>(
&self,
cancellable: Option<&P>
) -> Result<(SocketConnection, Option<Object>), Error>; fn accept_async<P: IsA<Cancellable>, Q: FnOnce(Result<(SocketConnection, Option<Object>), Error>) + Send + 'static>(
&self,
cancellable: Option<&P>,
callback: Q
); fn accept_async_future(
&self
) -> Pin<Box_<dyn Future<Output = Result<(SocketConnection, Option<Object>), Error>> + 'static>>; fn accept_socket<P: IsA<Cancellable>>(
&self,
cancellable: Option<&P>
) -> Result<(Socket, Option<Object>), Error>; fn accept_socket_async<P: IsA<Cancellable>, Q: FnOnce(Result<(Socket, Option<Object>), Error>) + Send + 'static>(
&self,
cancellable: Option<&P>,
callback: Q
); fn accept_socket_async_future(
&self
) -> Pin<Box_<dyn Future<Output = Result<(Socket, Option<Object>), Error>> + 'static>>; fn add_address<P: IsA<SocketAddress>, Q: IsA<Object>>(
&self,
address: &P,
type_: SocketType,
protocol: SocketProtocol,
source_object: Option<&Q>
) -> Result<SocketAddress, Error>; fn add_any_inet_port<P: IsA<Object>>(
&self,
source_object: Option<&P>
) -> Result<u16, Error>; fn add_inet_port<P: IsA<Object>>(
&self,
port: u16,
source_object: Option<&P>
) -> Result<(), Error>; fn add_socket<P: IsA<Socket>, Q: IsA<Object>>(
&self,
socket: &P,
source_object: Option<&Q>
) -> Result<(), Error>; fn close(&self); fn set_backlog(&self, listen_backlog: i32); fn listen_backlog(&self) -> i32; fn set_listen_backlog(&self, listen_backlog: i32); fn connect_event<F: Fn(&Self, SocketListenerEvent, &Socket) + 'static>(
&self,
f: F
) -> SignalHandlerId; fn connect_listen_backlog_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId;
Expand description
Required methods
Blocks waiting for a client to connect to any of the sockets added
to the listener. Returns a SocketConnection
for the socket that was
accepted.
If source_object
is not None
it will be filled out with the source
object specified when the corresponding socket or address was added
to the listener.
If cancellable
is not None
, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
was cancelled, the error IOErrorEnum::Cancelled
will be returned.
cancellable
optional Cancellable
object, None
to ignore.
Returns
a SocketConnection
on success, None
on error.
source_object
location where glib::Object
pointer will be stored, or None
fn accept_async<P: IsA<Cancellable>, Q: FnOnce(Result<(SocketConnection, Option<Object>), Error>) + Send + 'static>(
&self,
cancellable: Option<&P>,
callback: Q
)
fn accept_async<P: IsA<Cancellable>, Q: FnOnce(Result<(SocketConnection, Option<Object>), Error>) + Send + 'static>(
&self,
cancellable: Option<&P>,
callback: Q
)
This is the asynchronous version of accept()
.
When the operation is finished callback
will be
called. You can then call accept_socket()
to get the result of the operation.
cancellable
a Cancellable
, or None
callback
a GAsyncReadyCallback
fn accept_async_future(
&self
) -> Pin<Box_<dyn Future<Output = Result<(SocketConnection, Option<Object>), Error>> + 'static>>
Blocks waiting for a client to connect to any of the sockets added
to the listener. Returns the Socket
that was accepted.
If you want to accept the high-level SocketConnection
, not a Socket
,
which is often the case, then you should use accept()
instead.
If source_object
is not None
it will be filled out with the source
object specified when the corresponding socket or address was added
to the listener.
If cancellable
is not None
, then the operation can be cancelled by
triggering the cancellable object from another thread. If the operation
was cancelled, the error IOErrorEnum::Cancelled
will be returned.
cancellable
optional Cancellable
object, None
to ignore.
Returns
a Socket
on success, None
on error.
source_object
location where glib::Object
pointer will be stored, or None
.
This is the asynchronous version of accept_socket()
.
When the operation is finished callback
will be
called. You can then call g_socket_listener_accept_socket_finish()
to get the result of the operation.
cancellable
a Cancellable
, or None
callback
a GAsyncReadyCallback
fn accept_socket_async_future(
&self
) -> Pin<Box_<dyn Future<Output = Result<(Socket, Option<Object>), Error>> + 'static>>
fn add_address<P: IsA<SocketAddress>, Q: IsA<Object>>(
&self,
address: &P,
type_: SocketType,
protocol: SocketProtocol,
source_object: Option<&Q>
) -> Result<SocketAddress, Error>
fn add_address<P: IsA<SocketAddress>, Q: IsA<Object>>(
&self,
address: &P,
type_: SocketType,
protocol: SocketProtocol,
source_object: Option<&Q>
) -> Result<SocketAddress, Error>
Creates a socket of type type_
and protocol protocol
, binds
it to address
and adds it to the set of sockets we’re accepting
sockets from.
Note that adding an IPv6 address, depending on the platform,
may or may not result in a listener that also accepts IPv4
connections. For more deterministic behavior, see
add_inet_port()
.
source_object
will be passed out in the various calls
to accept to identify this particular source, which is
useful if you’re listening on multiple addresses and do
different things depending on what address is connected to.
If successful and effective_address
is non-None
then it will
be set to the address that the binding actually occurred at. This
is helpful for determining the port number that was used for when
requesting a binding to port 0 (ie: “any port”). This address, if
requested, belongs to the caller and must be freed.
Call close()
to stop listening on address
; this will not
be done automatically when you drop your final reference to self
, as
references may be held internally.
address
type_
protocol
source_object
Optional glib::Object
identifying this source
Returns
true
on success, false
on error.
effective_address
location to store the address that was bound to, or None
.
Listens for TCP connections on any available port number for both IPv6 and IPv4 (if each is available).
This is useful if you need to have a socket for incoming connections but don’t care about the specific port number.
source_object
will be passed out in the various calls
to accept to identify this particular source, which is
useful if you’re listening on multiple addresses and do
different things depending on what address is connected to.
source_object
Optional glib::Object
identifying this source
Returns
the port number, or 0 in case of failure.
Helper function for add_address()
that
creates a TCP/IP socket listening on IPv4 and IPv6 (if
supported) on the specified port on all interfaces.
source_object
will be passed out in the various calls
to accept to identify this particular source, which is
useful if you’re listening on multiple addresses and do
different things depending on what address is connected to.
Call close()
to stop listening on port
; this will not
be done automatically when you drop your final reference to self
, as
references may be held internally.
port
an IP port number (non-zero)
source_object
Optional glib::Object
identifying this source
Returns
Adds socket
to the set of sockets that we try to accept
new clients from. The socket must be bound to a local
address and listened to.
source_object
will be passed out in the various calls
to accept to identify this particular source, which is
useful if you’re listening on multiple addresses and do
different things depending on what address is connected to.
The socket
will not be automatically closed when the self
is finalized
unless the listener held the final reference to the socket. Before GLib 2.42,
the socket
was automatically closed on finalization of the self
, even
if references to it were held elsewhere.
socket
a listening Socket
source_object
Optional glib::Object
identifying this source
Returns
fn set_backlog(&self, listen_backlog: i32)
fn set_backlog(&self, listen_backlog: i32)
Sets the listen backlog on the sockets in the listener. This must be called
before adding any sockets, addresses or ports to the SocketListener
(for
example, by calling add_inet_port()
) to be effective.
See SocketExt::set_listen_backlog()
for details
listen_backlog
an integer
fn listen_backlog(&self) -> i32
fn set_listen_backlog(&self, listen_backlog: i32)
fn connect_event<F: Fn(&Self, SocketListenerEvent, &Socket) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_event<F: Fn(&Self, SocketListenerEvent, &Socket) + 'static>(
&self,
f: F
) -> SignalHandlerId
fn connect_listen_backlog_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId