dart:io
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.
- Implements
-
- Implemented by
Constructors
- RawSocket()
Properties
- address → InternetAddress
read-only
- Returns the InternetAddress used to connect this socket.
- port → int
read-only
- Returns the port used by this socket.
- readEventsEnabled ↔ bool
read / write
- Set or get, if the
RawSocket should listen for RawSocketEvent.read events. Default is true. - remoteAddress → InternetAddress
read-only
- Returns the remote InternetAddress connected to by this socket.
- remotePort → int
read-only
- Returns the remote port connected to by this socket.
- 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. - first → Future<RawSocketEvent>
read-only, inherited
- The first element of the stream. [...]
- hashCode → int
read-only, inherited
- The hash code for this object. [...]
- isBroadcast → bool
read-only, inherited
- Whether this stream is a broadcast stream.
- isEmpty → Future<bool>
read-only, inherited
- Whether this stream contains any elements. [...]
- last → Future<RawSocketEvent>
read-only, inherited
- The last element of this stream. [...]
- length → Future<int>
read-only, inherited
- The number of elements in this stream. [...]
- runtimeType → Type
read-only, inherited
- A representation of the runtime type of the object.
- single → Future<RawSocketEvent>
read-only, inherited
- The single element of this stream. [...]
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.readClosed 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>
inherited
- Checks whether
test accepts any element provided by this stream. [...] - 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. [...]
- asyncExpand<E>(Stream<E> convert(T event)) → Stream<E>
inherited
- Transforms each element into a sequence of asynchronous events. [...]
- asyncMap<E>(FutureOr<E> convert(T event)) → Stream<E>
inherited
- Creates a new stream with each data event of this stream asynchronously mapped to a new event. [...]
- cast<R>() → Stream<R>
inherited
- Adapt this stream to be a
Stream<R>. [...] - contains(Object needle) → Future<bool>
inherited
- Returns whether
needle occurs in the elements provided by this stream. [...] - distinct([bool equals(T previous, T next) ]) → Stream<RawSocketEvent>
inherited
- Skips data events if they are equal to the previous data event. [...]
- drain<E>([E futureValue ]) → Future<E>
inherited
- Discards all data on the stream, but signals when it's done or an error occurred. [...]
- elementAt(int index) → Future<RawSocketEvent>
inherited
- Returns the value of the
indexth data event of this stream. [...] - every(bool test(T element)) → Future<bool>
inherited
- Checks whether
test accepts all elements provided by this stream. [...] - expand<S>(Iterable<S> convert(T element)) → Stream<S>
inherited
- Transforms each element of this stream into a sequence of elements. [...]
- firstWhere(bool test(T element), { RawSocketEvent orElse() }) → Future<RawSocketEvent>
inherited
- Finds the first element of this stream matching
test. [...] - fold<S>(S initialValue, S combine(S previous, T element)) → Future<S>
inherited
- Combines a sequence of values by repeatedly applying
combine. [...] - forEach(void action(T element)) → Future
inherited
- Executes
action on each element of the stream. [...] - handleError(Function onError, { bool test(dynamic error) }) → Stream<RawSocketEvent>
inherited
- Creates a wrapper Stream that intercepts some errors from this stream. [...]
- join([String separator = "" ]) → Future<String>
inherited
- Combines the string representation of elements into a single string. [...]
- lastWhere(bool test(T element), { RawSocketEvent orElse() }) → Future<RawSocketEvent>
inherited
- Finds the last element in this stream matching
test. [...] - listen(void onData(T event), { Function onError, void onDone(), bool cancelOnError }) → StreamSubscription<RawSocketEvent>
inherited
- Adds a subscription to this stream. [...]
- map<S>(S convert(T event)) → Stream<S>
inherited
- Transforms each element of this stream into a new stream event. [...]
- noSuchMethod(Invocation invocation) → dynamic
inherited
- Invoked when a non-existent method or property is accessed. [...]
- pipe(StreamConsumer<RawSocketEvent> streamConsumer) → Future
inherited
- Pipes the events of this stream into
streamConsumer. [...] - reduce(RawSocketEvent combine(T previous, T element)) → Future<RawSocketEvent>
inherited
- Combines a sequence of values by repeatedly applying
combine. [...] - singleWhere(bool test(T element), { RawSocketEvent orElse() }) → Future<RawSocketEvent>
inherited
- Finds the single element in this stream matching
test. [...] - skip(int count) → Stream<RawSocketEvent>
inherited
- Skips the first
count data events from this stream. [...] - skipWhile(bool test(T element)) → Stream<RawSocketEvent>
inherited
- Skip data events from this stream while they are matched by
test. [...] - take(int count) → Stream<RawSocketEvent>
inherited
- Provides at most the first
count data events of this stream. [...] - takeWhile(bool test(T element)) → Stream<RawSocketEvent>
inherited
- Forwards data events while
test is successful. [...] - timeout(Duration timeLimit, { void onTimeout(EventSink<T> sink) }) → Stream<RawSocketEvent>
inherited
- Creates a new stream with the same events as this stream. [...]
- toList() → Future<List<RawSocketEvent>>
inherited
- Collects all elements of this stream in a List. [...]
- toSet() → Future<Set<RawSocketEvent>>
inherited
- Collects the data of this stream in a Set. [...]
- toString() → String
inherited
- Returns a string representation of this object.
- transform<S>(StreamTransformer<RawSocketEvent, S> streamTransformer) → Stream<S>
inherited
- Applies a StreamTransformer to the current stream. [...]
- where(bool test(T event)) → Stream<RawSocketEvent>
inherited
- Creates a new stream from this stream that discards some elements. [...]
Operators
- operator ==(dynamic other) → bool
inherited
- The equality operator. [...]
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.