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

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.

Constructors

RawSocket()

Properties

address → InternetAddress

Returns the InternetAddress used to connect this socket.

read-only
port → int

Returns the port used by this socket.

read-only
readEventsEnabled → bool

Set or get, if the RawSocket should listen for RawSocketEvent.READ events. Default is true.

read / write
remoteAddress → InternetAddress

Returns the remote InternetAddress connected to by this socket.

read-only
remotePort → int

Returns the remote port connected to by this socket.

read-only
writeEventsEnabled → bool

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.

read / write
first → Future<RawSocketEvent>

Returns the first element of the stream.

read-only, inherited
hashCode → int

The hash code for this object.

read-only, inherited
isBroadcast → bool

Whether this stream is a broadcast stream.

read-only, inherited
isEmpty → Future<bool>

Reports whether this stream contains any elements.

read-only, inherited
last → Future<RawSocketEvent>

Returns the last element of the stream.

read-only, inherited
length → Future<int>

Counts the elements in the stream.

read-only, inherited
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited
single → Future<RawSocketEvent>

Returns the single element.

read-only, inherited

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

available() → int

Returns the number of received and non-read bytes in the socket that can be read.

close() → Future<RawSocket>

Closes the socket. Returns a Future that completes with this when the underlying connection is completely destroyed.

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.

setOption(SocketOption option, bool enabled) → bool

Use setOption to customize the RawSocket. See SocketOption for available options.

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.

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.

any(bool test(T element)) → Future<bool>

Checks whether test accepts any element provided by this stream.

inherited
asBroadcastStream({void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription) }) → Stream<RawSocketEvent>

Returns a multi-subscription stream that produces the same events as this.

inherited
asyncExpand<E>(Stream<E> convert(T event)) → Stream<E>

Creates a new stream with the events of a stream per original event.

inherited
asyncMap<E>(dynamic convert(T event)) → Stream<E>

Creates a new stream with each data event of this stream asynchronously mapped to a new event.

inherited
contains(Object needle) → Future<bool>

Checks whether needle occurs in the elements provided by this stream.

inherited
distinct([bool equals(T previous, T next) ]) → Stream<RawSocketEvent>

Skips data events if they are equal to the previous data event.

inherited
drain<E>([E futureValue ]) → Future<E>

Discards all data on the stream, but signals when it's done or an error occurred.

inherited
elementAt(int index) → Future<RawSocketEvent>

Returns the value of the indexth data event of this stream.

inherited
every(bool test(T element)) → Future<bool>

Checks whether test accepts all elements provided by this stream.

inherited
expand<S>(Iterable<S> convert(T value)) → Stream<S>

Creates a new stream from this stream that converts each element into zero or more events.

inherited
firstWhere(bool test(T element), { Object defaultValue() }) → Future

Finds the first element of this stream matching test.

inherited
fold<S>(S initialValue, S combine(S previous, T element)) → Future<S>

Reduces a sequence of values by repeatedly applying combine.

inherited
forEach(void action(T element)) → Future

Executes action on each data event of the stream.

inherited
handleError(Function onError, { bool test(error) }) → Stream<RawSocketEvent>

Creates a wrapper Stream that intercepts some errors from this stream.

inherited
join([String separator = "" ]) → Future<String>

Collects string of data events' string representations.

inherited
lastWhere(bool test(T element), { Object defaultValue() }) → Future

Finds the last element in this stream matching test.

inherited
listen(void onData(T event), { Function onError, void onDone(), bool cancelOnError }) → StreamSubscription<RawSocketEvent>

Adds a subscription to this stream.

inherited
map<S>(S convert(T event)) → Stream<S>

Creates a new stream that converts each element of this stream to a new value using the convert function.

inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
pipe(StreamConsumer<RawSocketEvent> streamConsumer) → Future

Pipe the events of this stream into streamConsumer.

inherited
reduce(RawSocketEvent combine(T previous, T element)) → Future<RawSocketEvent>

Reduces a sequence of values by repeatedly applying combine.

inherited
singleWhere(bool test(T element)) → Future<RawSocketEvent>

Finds the single element in this stream matching test.

inherited
skip(int count) → Stream<RawSocketEvent>

Skips the first count data events from this stream.

inherited
skipWhile(bool test(T element)) → Stream<RawSocketEvent>

Skip data events from this stream while they are matched by test.

inherited
take(int count) → Stream<RawSocketEvent>

Provides at most the first count data events of this stream.

inherited
takeWhile(bool test(T element)) → Stream<RawSocketEvent>

Forwards data events while test is successful.

inherited
timeout(Duration timeLimit, { void onTimeout(EventSink<T> sink) }) → Stream<RawSocketEvent>

Creates a new stream with the same events as this stream.

inherited
toList() → Future<List<RawSocketEvent>>

Collects the data of this stream in a List.

inherited
toSet() → Future<Set<RawSocketEvent>>

Collects the data of this stream in a Set.

inherited
toString() → String

Returns a string representation of this object.

inherited
transform<S>(StreamTransformer<RawSocketEvent, S> streamTransformer) → Stream<S>

Chains this stream as the input of the provided StreamTransformer.

inherited
where(bool test(T event)) → Stream<RawSocketEvent>

Creates a new stream from this stream that discards some data events.

inherited