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
Implemented by

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 event.
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 immediate reading. If no data is available null is returned.
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 buffer space is available in the socket.
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 SocketDirection.RECEIVE can result in a RawSocketEvent.READ_CLOSED event.
setOption(SocketOption option, bool enabled) → bool
Use setOption to customize the RawSocket. See SocketOption for available options.
pipe(StreamConsumer<RawSocketEvent> streamConsumer) → Future Inherited
Pipe the events of this stream into streamConsumer.
take(int count) → Stream<RawSocketEvent> Inherited
Provides at most the first n values of this stream.
map(dynamic convert(T event)) → Stream Inherited
Creates a new stream that converts each element of this stream to a new value using the convert function.
listen(void onData(T event), {Function onError, void onDone(), bool cancelOnError}) → StreamSubscription<RawSocketEvent> Inherited
Adds a subscription to this stream.
timeout(Duration timeLimit, {void onTimeout(EventSink sink)}) → Stream Inherited
Creates a new stream with the same events as this stream.
distinct([bool equals(T previous, T next)]) → Stream<RawSocketEvent> Inherited
Skips data events if they are equal to the previous data event.
takeWhile(bool test(T element)) → Stream<RawSocketEvent> Inherited
Forwards data events while test is successful.
fold(initialValue, dynamic combine(previous, T element)) → Future Inherited
Reduces a sequence of values by repeatedly applying combine.
toSet() → Future<Set<RawSocketEvent>> Inherited
Collects the data of this stream in a Set.
firstWhere(bool test(T element), {Object defaultValue()}) → Future Inherited
Finds the first element of this stream matching test.
forEach(void action(T element)) → Future Inherited
Executes action on each data event of the stream.
skipWhile(bool test(T element)) → Stream<RawSocketEvent> Inherited
Skip data events from this stream while they are matched by test.
join([String separator = ""]) → Future<String> Inherited
Collects string of data events' string representations.
contains(Object needle) → Future<bool> Inherited
Checks whether needle occurs in the elements provided by this stream.
asyncExpand(Stream convert(T event)) → Stream Inherited
Creates a new stream with the events of a stream per original event.
lastWhere(bool test(T element), {Object defaultValue()}) → Future Inherited
Finds the last element in this stream matching test.
singleWhere(bool test(T element)) → Future<RawSocketEvent> Inherited
Finds the single element in this stream matching test.
drain([futureValue]) → Future Inherited
Discards all data on the stream, but signals when it's done or an error occured.
asyncMap(dynamic convert(T event)) → Stream Inherited
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
handleError(Function onError, {bool test(error)}) → Stream<RawSocketEvent> Inherited
Creates a wrapper Stream that intercepts some errors from this stream.
reduce(T combine(T previous, T element)) → Future<RawSocketEvent> Inherited
Reduces a sequence of values by repeatedly applying combine.
transform(StreamTransformer<RawSocketEvent> streamTransformer) → Stream Inherited
Chains this stream as the input of the provided StreamTransformer.
every(bool test(T element)) → Future<bool> Inherited
Checks whether test accepts all elements provided by this stream.
any(bool test(T element)) → Future<bool> Inherited
Checks whether test accepts any element provided by this stream.
toList() → Future<List<RawSocketEvent>> Inherited
Collects the data of this stream in a List.
where(bool test(T event)) → Stream<RawSocketEvent> Inherited
Creates a new stream from this stream that discards some data events.
asBroadcastStream({void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription)}) → Stream<RawSocketEvent> Inherited
Returns a multi-subscription stream that produces the same events as this.
skip(int count) → Stream<RawSocketEvent> Inherited
Skips the first count data events from this stream.
expand(Iterable convert(T value)) → Stream Inherited
Creates a new stream from this stream that converts each element into zero or more events.
elementAt(int index) → Future<RawSocketEvent> Inherited
Returns the value of the indexth data event of this stream.