RawSocket class

The RawSocket is a low-level interface to a socket, exposing the raw events signaled by the system. It's a Stream of RawSocketEvents.

The RawSocket is a low-level interface to a socket, exposing the raw events signaled by the system. It's a Stream of RawSocketEvents.

Implements:
Implementors

Constructors

RawSocket ( )

Static Methods

connect ( host, int port, {sourceAddress} ) → Future<RawSocket>
Creates a new socket connection to the host and port and returns a Future that will complete with either a RawSocket once connected or an error if the host-lookup or connection failed.

Instance Properties

readEventsEnabled bool
read/write
Set or get, if the RawSocket should listen for RawSocketEvent.READ events. Default is true.
writeEventsEnabled bool
read/write
Set or get, if the RawSocket should listen for RawSocketEvent.WRITE events. Default is true. This is a one-shot listener, and writeEventsEnabled must be set to true again to receive another write ...
port int
read-only
remotePort int
read-only
address InternetAddress
read-only
remoteAddress InternetAddress
read-only
isEmpty Future<bool> Inherited
read-only
isBroadcast bool Inherited
read-only
first Future<RawSocketEvent> Inherited
read-only
last Future<RawSocketEvent> Inherited
read-only
single Future<RawSocketEvent> Inherited
read-only
length Future<int> Inherited
read-only

Instance Methods

available ( ) → int
Returns the number of received and non-read bytes in the socket that can be read.
read ( [int len] ) → List<int>
Read up to len bytes from the socket. This function is non-blocking and will only return data if data is available. The number of bytes read can be less then len if fewer bytes are available for i...
write ( List<int> buffer, [int offset, int count] ) → int
Writes up to count bytes of the buffer from offset buffer offset to the socket. The number of successfully written bytes is returned. This function is non-blocking and will only write data if buff...
close ( ) → Future<RawSocket>
Closes the socket. Returns a Future that completes with this when the underlying connection is completely destroyed.
shutdown ( SocketDirection direction ) → void
Shutdown the socket in the direction. Calling shutdown will never throw an exception and calling it several times is supported. Calling shutdown with either SocketDirection.BOTH or [SocketDirect...
setOption ( SocketOption option, bool enabled ) → bool
Use setOption to customize the RawSocket. See SocketOption for available options.
pipe Inherited ( StreamConsumer<RawSocketEvent> streamConsumer ) → Future
Pipe the events of this stream into streamConsumer.
take Inherited ( int count ) → Stream<RawSocketEvent>
Provides at most the first n values of this stream.
map Inherited ( dynamic convert(T event) ) → Stream
Creates a new stream that converts each element of this stream to a new value using the convert function.
listen Inherited ( void onData(T event), {Function onError, void onDone(), bool cancelOnError} ) → StreamSubscription<RawSocketEvent>
Adds a subscription to this stream.
timeout Inherited ( Duration timeLimit, {void onTimeout(EventSink sink)} ) → Stream
Creates a new stream with the same events as this stream.
distinct Inherited ( [bool equals(T previous, T next)] ) → Stream<RawSocketEvent>
Skips data events if they are equal to the previous data event.
takeWhile Inherited ( bool test(T element) ) → Stream<RawSocketEvent>
Forwards data events while test is successful.
fold Inherited ( initialValue, dynamic combine(previous, T element) ) → Future
Reduces a sequence of values by repeatedly applying combine.
toSet Inherited ( ) → Future<Set<RawSocketEvent>>
Collects the data of this stream in a Set.
firstWhere Inherited ( bool test(T element), {Object defaultValue()} ) → Future
Finds the first element of this stream matching test.
forEach Inherited ( void action(T element) ) → Future
Executes action on each data event of the stream.
skipWhile Inherited ( bool test(T element) ) → Stream<RawSocketEvent>
Skip data events from this stream while they are matched by test.
join Inherited ( [String separator = ""] ) → Future<String>
Collects string of data events' string representations.
contains Inherited ( Object needle ) → Future<bool>
Checks whether needle occurs in the elements provided by this stream.
asyncExpand Inherited ( Stream convert(T event) ) → Stream
Creates a new stream with the events of a stream per original event.
lastWhere Inherited ( bool test(T element), {Object defaultValue()} ) → Future
Finds the last element in this stream matching test.
singleWhere Inherited ( bool test(T element) ) → Future<RawSocketEvent>
Finds the single element in this stream matching test.
drain Inherited ( [futureValue] ) → Future
Discards all data on the stream, but signals when it's done or an error occured.
asyncMap Inherited ( dynamic convert(T event) ) → Stream
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
handleError Inherited ( Function onError, {bool test(error)} ) → Stream<RawSocketEvent>
Creates a wrapper Stream that intercepts some errors from this stream.
reduce Inherited ( T combine(T previous, T element) ) → Future<RawSocketEvent>
Reduces a sequence of values by repeatedly applying combine.
transform Inherited ( StreamTransformer<RawSocketEvent> streamTransformer ) → Stream
Chains this stream as the input of the provided StreamTransformer.
every Inherited ( bool test(T element) ) → Future<bool>
Checks whether test accepts all elements provided by this stream.
any Inherited ( bool test(T element) ) → Future<bool>
Checks whether test accepts any element provided by this stream.
toList Inherited ( ) → Future<List<RawSocketEvent>>
Collects the data of this stream in a List.
where Inherited ( bool test(T event) ) → Stream<RawSocketEvent>
Creates a new stream from this stream that discards some data events.
asBroadcastStream Inherited ( {void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription)} ) → Stream<RawSocketEvent>
Returns a multi-subscription stream that produces the same events as this.
skip Inherited ( int count ) → Stream<RawSocketEvent>
Skips the first count data events from this stream.
expand Inherited ( Iterable convert(T value) ) → Stream
Creates a new stream from this stream that converts each element into zero or more events.
elementAt Inherited ( int index ) → Future<RawSocketEvent>
Returns the value of the indexth data event of this stream.