description

# RawSocket class Null safety

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.close`).

Implemented types
  - Stream<RawSocketEvent>
Implementers
  - RawSecureSocket

## Constructors

RawSocket()

## Properties

address → InternetAddress
  Returns the InternetAddress used to connect this socket. [...]
  read-only
first → Future<RawSocketEvent>
  The first element of this 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>
  Whether this stream contains any elements. [...]
  read-only, inherited
last → Future<RawSocketEvent>
  The last element of this stream. [...]
  read-only, inherited
length → Future<int>
  The number of elements in this stream. [...]
  read-only, inherited
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
runtimeType → Type
  A representation of the runtime type of the object.
  read-only, inherited
single → Future<RawSocketEvent>
  The single element of this stream. [...]
  read-only, inherited
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

## 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
  Returns 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. Returns a Future that completes with this when the underlying connection is completely destroyed. [...]
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
  Executes `action` on each element of this stream. [...]
  inherited
getRawOption(RawSocketOption option) → Uint8List
  Use getRawOption to get low level information about the RawSocket. See RawSocketOption for available options. [...]
  @Since("2.2")
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 non-existent 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. 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.
reduce(RawSocketEvent combine(RawSocketEvent previous, RawSocketEvent element)) → Future<RawSocketEvent>
  Combines a sequence of values by repeatedly applying `combine`. [...]
  inherited
setOption(SocketOption option, bool enabled) → bool
  Use setOption to customize the RawSocket. See SocketOption for available options. [...]
setRawOption(RawSocketOption option) → void
  Use setRawOption to customize the RawSocket. See RawSocketOption for available options. [...]
  @Since("2.2")
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.readClosed event.
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
  Returns 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 event)) → 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. 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. [...]

## Operators

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

## Static Methods

connect(dynamic host, int port, {dynamic sourceAddress, Duration? timeout}) → 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. [...]
startConnect(dynamic host, int port, {dynamic sourceAddress}) → 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.