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.

Implements
Implemented by

Static Methods

connect(host, int port, { sourceAddress }) → 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.

Constructors

Socket()

Properties

address → InternetAddress

Returns the InternetAddress used to connect this socket.

read-only
done → Future<Socket>

read-only
encoding → Encoding

The Encoding used when writing strings. Depending on the underlying consumer this property might be mutable.

read / write, inherited
first → Future<List<int>>

Returns the first element of the stream.

read-only, inherited
hashCode → int

Get a hash code for this object.

read-only, inherited
isBroadcast → bool

Reports 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<List<int>>

Returns the last element of the stream.

read-only, inherited
length → Future<int>

Counts the elements in the stream.

read-only, inherited
port → int

Returns the port used by this socket.

read-only
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<List<int>>

Returns the single element.

read-only, inherited

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

add(List<int> data) → void

Adds byte data to the target consumer, ignoring encoding.

inherited
addError(error, [ StackTrace stackTrace ]) → void

Passes the error to the target consumer as an error event.

inherited
addStream(Stream<List<int>> stream) → Future

Adds all elements of the given stream to this.

inherited
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<List<int>>

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

inherited
asyncExpand(Stream convert(T event)) → Stream

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

inherited
asyncMap(dynamic convert(T event)) → Stream

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

inherited
close() → Future<Socket>

Close the target consumer.

contains(Object needle) → Future<bool>

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

inherited
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.

distinct([bool equals(T previous, T next) ]) → Stream<List<int>>

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

inherited
drain([futureValue ]) → Future

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

inherited
elementAt(int index) → Future<List<int>>

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(Iterable convert(T value)) → Stream

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
flush() → Future

Returns a Future that completes once all buffered data is accepted by the to underlying StreamConsumer.

inherited
fold(initialValue, dynamic combine(previous, T element)) → Future

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<List<int>>

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<List<int>>

Adds a subscription to this stream.

inherited
map(dynamic convert(T event)) → Stream

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<List<int>> streamConsumer) → Future

Pipe the events of this stream into streamConsumer.

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

Reduces 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.

singleWhere(bool test(T element)) → Future<List<int>>

Finds the single element in this stream matching test.

inherited
skip(int count) → Stream<List<int>>

Skips the first count data events from this stream.

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

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

inherited
take(int count) → Stream<List<int>>

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

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

Forwards data events while test is successful.

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

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

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

Collects the data of this stream in a List.

inherited
toSet() → Future<Set<List<int>>>

Collects the data of this stream in a Set.

inherited
toString() → String

Returns a string representation of this object.

inherited
transform(StreamTransformer<List<int>, dynamic> streamTransformer) → Stream

Chains this stream as the input of the provided StreamTransformer.

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

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

inherited
write(Object obj) → void

Converts obj to a String by invoking Object.toString and adds the encoding of the result to the target consumer.

inherited
writeAll(Iterable objects, [ String separator = "" ]) → void

Iterates over the given objects and writes them in sequence.

inherited
writeCharCode(int charCode) → void

Writes the character of charCode.

inherited
writeln([Object obj = "" ]) → void

Converts obj to a String by invoking Object.toString and writes the result to this, followed by a newline.

inherited