dart:io
Socket class
A high-level class for communicating over a TCP socket.
The Socket exposes both a Stream and a IOSink interface, making it ideal for using together with other Streams.
- Implemented types
-
- Implementers
Constructors
- Socket()
Properties
- address → InternetAddress
read-only
- Returns the InternetAddress used to connect this socket.
- done → Future
read-only, override
- Get a future that will complete when the consumer closes, or when an error occurs. This future is identical to the future returned by close.
- port → int
read-only
- Returns the port used by this socket.
- 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.
- encoding ↔ Encoding
read / write, inherited
- The Encoding used when writing strings. Depending on the underlying consumer this property might be mutable.
- first → Future<Uint8List>
read-only, inherited
- The first element of this 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<Uint8List>
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<Uint8List>
read-only, inherited
- The single element of this stream. [...]
Methods
- close() → Future
override
- Close the target consumer. [...]
- destroy() → void
- Destroy the socket in both directions. Calling destroy will make the send a close event on the stream and will no longer react on data being piped to it. [...]
- getRawOption(RawSocketOption option) → Uint8List
- Use getRawOption to get low level information about the RawSocket. See RawSocketOption for available options. [...]
- 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. [...]
- add(List<int> data) → void
inherited
- Adds byte
data to the target consumer, ignoring encoding. [...] - addError(Object error, [ StackTrace stackTrace ]) → void
inherited
- Passes the error to the target consumer as an error event. [...]
- addStream(Stream<List<int>> stream) → Future
inherited
- Adds all elements of the given
stream to this. [...] - 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<Uint8List>
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<Uint8List>
inherited
- Skips data events if they are equal to the previous data event. [...]
- drain<E>([E futureValue ]) → Future<E>
inherited
- Discards all data on this stream, but signals when it is done or an error occurred. [...]
- elementAt(int index) → Future<Uint8List>
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), { Uint8List orElse() }) → Future<Uint8List>
inherited
- Finds the first element of this stream matching
test. [...] - flush() → Future
inherited
- Returns a Future that completes once all buffered data is accepted by the underlying StreamConsumer. [...]
- 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 this stream. [...] - handleError(Function onError, { bool test(dynamic error) }) → Stream<Uint8List>
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), { Uint8List orElse() }) → Future<Uint8List>
inherited
- Finds the last element in this stream matching
test. [...] - listen(void onData(T event), { Function onError, void onDone(), bool cancelOnError }) → StreamSubscription<Uint8List>
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<Uint8List> streamConsumer) → Future
inherited
- Pipes the events of this stream into
streamConsumer. [...] - reduce(Uint8List combine(T previous, T element)) → Future<Uint8List>
inherited
- Combines a sequence of values by repeatedly applying
combine. [...] - singleWhere(bool test(T element), { Uint8List orElse() }) → Future<Uint8List>
inherited
- Finds the single element in this stream matching
test. [...] - skip(int count) → Stream<Uint8List>
inherited
- Skips the first
count data events from this stream. [...] - skipWhile(bool test(T element)) → Stream<Uint8List>
inherited
- Skip data events from this stream while they are matched by
test. [...] - take(int count) → Stream<Uint8List>
inherited
- Provides at most the first
count data events of this stream. [...] - takeWhile(bool test(T element)) → Stream<Uint8List>
inherited
- Forwards data events while
test is successful. [...] - timeout(Duration timeLimit, { void onTimeout(EventSink<T> sink) }) → Stream<Uint8List>
inherited
- Creates a new stream with the same events as this stream. [...]
- toList() → Future<List<Uint8List>>
inherited
- Collects all elements of this stream in a List. [...]
- toSet() → Future<Set<Uint8List>>
inherited
- Collects the data of this stream in a Set. [...]
- toString() → String
inherited
- Returns a string representation of this object.
- transform<S>(StreamTransformer<Uint8List, S> streamTransformer) → Stream<S>
inherited
- Applies
streamTransformer to this stream. [...] - where(bool test(T event)) → Stream<Uint8List>
inherited
- Creates a new stream from this stream that discards some elements. [...]
- write(Object obj) → void
inherited
- Converts
obj to a String by invoking Object.toString and adds the encoding of the result to the target consumer. [...] - writeAll(Iterable objects, [ String separator = "" ]) → void
inherited
- Iterates over the given
objects and writes them in sequence. [...] - writeCharCode(int charCode) → void
inherited
- Writes the character of
charCode. [...] - writeln([Object obj = "" ]) → void
inherited
- Converts
obj to a String by invoking Object.toString and writes the result to this, followed by a newline. [...]
Operators
- operator ==(dynamic other) → bool
inherited
- The equality operator. [...]
Static Methods
- connect(dynamic host, int port, { dynamic sourceAddress, Duration timeout }) → Future<Socket>
- Creates a new socket connection to the host and port and returns a Future that will complete with either a Socket once connected or an error if the host-lookup or connection failed. [...]
- startConnect(dynamic host, int port, { dynamic sourceAddress }) → Future<ConnectionTask<Socket>>
- Like connect, but returns a Future that completes with a ConnectionTask that can be cancelled if the Socket is no longer needed.