86 lines
3.5 KiB
Plaintext
86 lines
3.5 KiB
Plaintext
class Efl.Net.Dialer.Simple (Efl.Net.Socket.Simple, Efl.Net.Dialer) {
|
|
[[Connects to a remote server offering an easy to use, buffered I/O.
|
|
|
|
The simple dialer is based on @Efl.Net.Socket.Simple, that
|
|
encapsulates an actual @Efl.Net.Socket, and uses it with an
|
|
@Efl.Io.Buffered_Stream, which creates an input @Efl.Io.Queue,
|
|
an output @Efl.Io.Queue and these are linked using a receiver
|
|
and a sender @Efl.Io.Copier.
|
|
|
|
The idea is that unlike traditional @Efl.Net.Socket that will
|
|
attempt to write directly to socket and thus may take less data
|
|
than requested, this one will keep the pending data in its own
|
|
buffer, feeding to the actual socket when it
|
|
@Efl.Io.Writer.can_write. That makes its operation much simpler
|
|
as @Efl.Io.Writer.write will always take the full data -- allows
|
|
"write and forget", if unlimited (see
|
|
@Efl.Io.Buffered_Stream.max_queue_size_output).
|
|
|
|
Reading is also much simpler since received data is kept in an
|
|
@Efl.Io.Queue, thus its size can be queried with
|
|
@Efl.Io.Buffered_Stream.pending_read and read with
|
|
@Efl.Io.Reader.read or peeked with
|
|
@Efl.Io.Buffered_Stream.slice, then discarded with
|
|
@Efl.Io.Buffered_Stream.discard or
|
|
@Efl.Io.Buffered_Stream.clear.
|
|
|
|
Then when waiting for a complete message, just peek at its
|
|
contents, if not complete do nothing, if complete then either
|
|
@Efl.Io.Reader.read to get a copy or manipulate a read-only
|
|
reference from @Efl.Io.Buffered_Stream.slice and then
|
|
@Efl.Io.Buffered_Stream.discard
|
|
|
|
The actual dialer is created using the class given as the
|
|
constructor property @.inner_class and can be retrieved with
|
|
@Efl.Io.Buffered_Stream.inner_io, which should be used with
|
|
care, like extra configuration before @Efl.Net.Dialer.dial is
|
|
called.
|
|
|
|
If your object class requires some constructor-only properties
|
|
to be set prior to @Efl.Object.finalize, then use
|
|
@Efl.Io.Buffered_Stream.inner_io directly providing an already
|
|
created dialer.
|
|
|
|
@since 1.19
|
|
]]
|
|
|
|
methods {
|
|
@property inner_class {
|
|
[[The class used to create @Efl.Io.Buffered_Stream.inner_io if none was provided.
|
|
|
|
This class could be set at construction time and will be
|
|
used to create the inner socket during
|
|
@Efl.Object.finalize.
|
|
|
|
It is a helper for users, removing the burden to
|
|
manually create and specify a dialer object.
|
|
]]
|
|
get {
|
|
[[The internal class used to create the inner dialer.]]
|
|
}
|
|
set {
|
|
[[Constructor-only property to define the class used to create the inner dialer.]]
|
|
}
|
|
values {
|
|
klass: const(Efl.Class); [[The class]]
|
|
}
|
|
}
|
|
}
|
|
|
|
implements {
|
|
Efl.Object.finalize;
|
|
Efl.Object.destructor;
|
|
Efl.Io.Buffered_Stream.inner_io { set; }
|
|
Efl.Net.Dialer.dial;
|
|
Efl.Net.Dialer.address_dial { get; }
|
|
Efl.Net.Dialer.connected { get; }
|
|
Efl.Net.Dialer.proxy { get; set; }
|
|
Efl.Net.Dialer.timeout_dial { get; set; }
|
|
Efl.Io.Buffered_Stream.timeout_inactivity { get; set; }
|
|
Efl.Io.Buffered_Stream.max_queue_size_input { get; set; }
|
|
Efl.Io.Buffered_Stream.max_queue_size_output { get; set; }
|
|
Efl.Io.Buffered_Stream.read_chunk_size { get; set; }
|
|
Efl.Io.Buffered_Stream.line_delimiter { get; set; }
|
|
}
|
|
}
|