description

# RawSocket class abstract interface

A TCP connection.

A socket connection connects a local socket to a remote socket. Data, as Uint8Lists, is received by the local socket and made available by the read method, and can be sent to the remote socket through the write method.

The Stream interface of this class provides event notification about when a certain change has happened, for example when data has become available (RawSocketEvent.read) or when the remote end has stopped listening (RawSocketEvent.closed).

Implemented types
  - Stream<RawSocketEvent>
Implementers
  - RawSecureSocket

## Properties

address → InternetAddress
  The InternetAddress used to connect this socket.
  no setter
first → Future<RawSocketEvent>
  The first element of this stream.
  no setterinherited
hashCode → int
  The hash code for this object.
  no setterinherited
isBroadcast → bool
  Whether this stream is a broadcast stream.
  no setterinherited
isEmpty → Future<bool>
  Whether this stream contains any elements.
  no setterinherited
last → Future<RawSocketEvent>
  The last element of this stream.
  no setterinherited
length → Future<int>
  The number of elements in this stream.
  no setterinherited
port → int
  The port used by this socket.
  no setter
readEventsEnabled ↔ bool
  Set or get, if the RawSocket should listen for RawSocketEvent.read and RawSocketEvent.readClosed events. Default is `true`.
  getter/setter pair
remoteAddress → InternetAddress
  The remote InternetAddress connected to by this socket.
  no setter
remotePort → int
  The remote port connected to by this socket.
  no setter
runtimeType → Type
  A representation of the runtime type of the object.
  no setterinherited
single → Future<RawSocketEvent>
  The single element of this stream.
  no setterinherited
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.
  getter/setter pair

## Methods

any(bool test(RawSocketEvent element)) → Future<bool>
  Checks whether `test` accepts any element provided by this stream.
  inherited
asBroadcastStream({void onListen(StreamSubscription<RawSocketEvent> subscription)?, void onCancel(StreamSubscription<RawSocketEvent> subscription)?}) → Stream<RawSocketEvent>
  Returns a multi-subscription stream that produces the same events as this.
  inherited
asyncExpand<E>(Stream<E>? convert(RawSocketEvent event)) → Stream<E>
  Transforms each element into a sequence of asynchronous events.
  inherited
asyncMap<E>(FutureOr<E> convert(RawSocketEvent event)) → Stream<E>
  Creates a new stream with each data event of this stream asynchronously mapped to a new event.
  inherited
available() → int
  The number of received and non-read bytes in the socket that can be read.
cast<R>() → Stream<R>
  Adapt this stream to be a `Stream<R>`.
  inherited
close() → Future<RawSocket>
  Closes the socket.
contains(Object? needle) → Future<bool>
  Returns whether `needle` occurs in the elements provided by this stream.
  inherited
distinct([bool equals(RawSocketEvent previous, RawSocketEvent 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 this stream, but signals when it is done or an error occurred.
  inherited
elementAt(int index) → Future<RawSocketEvent>
  Returns the value of the `index`th data event of this stream.
  inherited
every(bool test(RawSocketEvent element)) → Future<bool>
  Checks whether `test` accepts all elements provided by this stream.
  inherited
expand<S>(Iterable<S> convert(RawSocketEvent element)) → Stream<S>
  Transforms each element of this stream into a sequence of elements.
  inherited
firstWhere(bool test(RawSocketEvent element), {RawSocketEvent orElse()?}) → Future<RawSocketEvent>
  Finds the first element of this stream matching `test`.
  inherited
fold<S>(S initialValue, S combine(S previous, RawSocketEvent element)) → Future<S>
  Combines a sequence of values by repeatedly applying `combine`.
  inherited
forEach(void action(RawSocketEvent element)) → Future<void>
  Executes `action` on each element of this stream.
  inherited
getRawOption(RawSocketOption option) → Uint8List
  Reads low level information about the RawSocket.
handleError(Function onError, {bool test(dynamic error)?}) → Stream<RawSocketEvent>
  Creates a wrapper Stream that intercepts some errors from this stream.
  inherited
join([String separator = ""]) → Future<String>
  Combines the string representation of elements into a single string.
  inherited
lastWhere(bool test(RawSocketEvent element), {RawSocketEvent orElse()?}) → Future<RawSocketEvent>
  Finds the last element in this stream matching `test`.
  inherited
listen(void onData(RawSocketEvent event)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<RawSocketEvent>
  Adds a subscription to this stream.
  inherited
map<S>(S convert(RawSocketEvent event)) → Stream<S>
  Transforms each element of this stream into a new stream event.
  inherited
noSuchMethod(Invocation invocation) → dynamic
  Invoked when a nonexistent method or property is accessed.
  inherited
pipe(StreamConsumer<RawSocketEvent> streamConsumer) → Future
  Pipes the events of this stream into `streamConsumer`.
  inherited
read([int? len]) → Uint8List?
  Read up to `len` bytes from the socket.
readMessage([int? count]) → SocketMessage?
  Reads a message containing up to `count` bytes from the socket.
reduce(RawSocketEvent combine(RawSocketEvent previous, RawSocketEvent element)) → Future<RawSocketEvent>
  Combines a sequence of values by repeatedly applying `combine`.
  inherited
sendMessage(List<SocketControlMessage> controlMessages, List<int> data, [int offset = 0, int? count]) → int
  Writes socket control messages and data bytes to the socket.
setOption(SocketOption option, bool enabled) → bool
  Customize the RawSocket.
setRawOption(RawSocketOption option) → void
  Customizes the RawSocket.
shutdown(SocketDirection direction) → void
  Shuts down the socket in the `direction`.
singleWhere(bool test(RawSocketEvent element), {RawSocketEvent orElse()?}) → 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(RawSocketEvent 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(RawSocketEvent element)) → Stream<RawSocketEvent>
  Forwards data events while `test` is successful.
  inherited
timeout(Duration timeLimit, {void onTimeout(EventSink<RawSocketEvent> sink)?}) → Stream<RawSocketEvent>
  Creates a new stream with the same events as this stream.
  inherited
toList() → Future<List<RawSocketEvent>>
  Collects all elements of this stream in a List.
  inherited
toSet() → Future<Set<RawSocketEvent>>
  Collects the data of this stream in a Set.
  inherited
toString() → String
  A string representation of this object.
  inherited
transform<S>(StreamTransformer<RawSocketEvent, S> streamTransformer) → Stream<S>
  Applies `streamTransformer` to this stream.
  inherited
where(bool test(RawSocketEvent element)) → Stream<RawSocketEvent>
  Creates a new stream from this stream that discards some elements.
  inherited
write(List<int> buffer, [int offset = 0, int? count]) → int
  Writes up to `count` bytes of the buffer from `offset` buffer offset to the socket.

## Operators

operator ==(Object other) → bool
  The equality operator.
  inherited

## Static Methods

connect(dynamic host, int port, {dynamic sourceAddress, int sourcePort = 0, Duration? timeout}) → Future<RawSocket>
  Creates a new socket connection to the host and port.
startConnect(dynamic host, int port, {dynamic sourceAddress, int sourcePort = 0}) → Future<ConnectionTask<RawSocket>>
  Like connect, but returns a Future that completes with a ConnectionTask that can be cancelled if the RawSocket is no longer needed.