Socket class

A high-level class for communicating over a TCP socket.

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:
Implementors

Constructors

Socket ( )

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.

Instance Properties

port int
read-only
remotePort int
read-only
address InternetAddress
read-only
remoteAddress InternetAddress
read-only
encoding Encoding Inherited
read/write
The Encoding used when writing strings. Depending on the underlying consumer this property might be mutable.
last Future<List<int>> Inherited
read-only
single Future<List<int>> Inherited
read-only
length Future<int> Inherited
read-only
done Future Inherited
read-only
isEmpty Future<bool> Inherited
read-only
isBroadcast bool Inherited
read-only
first Future<List<int>> Inherited
read-only

Instance Methods

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.
setOption ( SocketOption option, bool enabled ) → bool
Use setOption to customize the RawSocket. See SocketOption for available options.
writeCharCode Inherited ( int charCode ) → void
Writes the charCode to this.
take Inherited ( int count ) → Stream<List<int>>
Provides at most the first n values of this stream.
map Inherited ( dynamic convert(T event) ) → Stream
Creates a new stream that converts each element of this stream to a new value using the convert function.
listen Inherited ( void onData(T event), {Function onError, void onDone(), bool cancelOnError} ) → StreamSubscription<List<int>>
Adds a subscription to this stream.
timeout Inherited ( Duration timeLimit, {void onTimeout(EventSink sink)} ) → Stream
Creates a new stream with the same events as this stream.
distinct Inherited ( [bool equals(T previous, T next)] ) → Stream<List<int>>
Skips data events if they are equal to the previous data event.
addStream Inherited ( Stream<List<int>> stream ) → Future
Adds all elements of the given stream to this.
toSet Inherited ( ) → Future<Set<List<int>>>
Collects the data of this stream in a Set.
forEach Inherited ( void action(T element) ) → Future
Executes action on each data event of the stream.
skipWhile Inherited ( bool test(T element) ) → Stream<List<int>>
Skip data events from this stream while they are matched by test.
join Inherited ( [String separator = ""] ) → Future<String>
Collects string of data events' string representations.
writeln Inherited ( [Object obj = ""] ) → void
Converts obj to a String by invoking Object.toString and writes the result to this, followed by a newline.
flush Inherited ( ) → Future
Returns a Future that completes once all buffered data is accepted by the to underlying StreamConsumer.
lastWhere Inherited ( bool test(T element), {Object defaultValue()} ) → Future
Finds the last element in this stream matching test.
addError Inherited ( error, [StackTrace stackTrace] ) → void
Passes the error to the target consumer as an error event.
reduce Inherited ( T combine(T previous, T element) ) → Future<List<int>>
Reduces a sequence of values by repeatedly applying combine.
handleError Inherited ( Function onError, {bool test(error)} ) → Stream<List<int>>
Creates a wrapper Stream that intercepts some errors from this stream.
transform Inherited ( StreamTransformer<List<int>> streamTransformer ) → Stream
Chains this stream as the input of the provided StreamTransformer.
any Inherited ( bool test(T element) ) → Future<bool>
Checks whether test accepts any element provided by this stream.
every Inherited ( bool test(T element) ) → Future<bool>
Checks whether test accepts all elements provided by this stream.
where Inherited ( bool test(T event) ) → Stream<List<int>>
Creates a new stream from this stream that discards some data events.
skip Inherited ( int count ) → Stream<List<int>>
Skips the first count data events from this stream.
expand Inherited ( Iterable convert(T value) ) → Stream
Creates a new stream from this stream that converts each element into zero or more events.
elementAt Inherited ( int index ) → Future<List<int>>
Returns the value of the indexth data event of this stream.
pipe Inherited ( StreamConsumer<List<int>> streamConsumer ) → Future
Pipe the events of this stream into streamConsumer.
takeWhile Inherited ( bool test(T element) ) → Stream<List<int>>
Forwards data events while test is successful.
write Inherited ( Object obj ) → void
Converts obj to a String by invoking Object.toString and adds the encoding of the result to the target consumer.
fold Inherited ( initialValue, dynamic combine(previous, T element) ) → Future
Reduces a sequence of values by repeatedly applying combine.
firstWhere Inherited ( bool test(T element), {Object defaultValue()} ) → Future
Finds the first element of this stream matching test.
contains Inherited ( Object needle ) → Future<bool>
Checks whether needle occurs in the elements provided by this stream.
writeAll Inherited ( Iterable objects, [String separator = ""] ) → void
Iterates over the given objects and writes them in sequence.
asyncExpand Inherited ( Stream convert(T event) ) → Stream
Creates a new stream with the events of a stream per original event.
add Inherited ( List<int> data ) → void
Adds data to the target consumer, ignoring encoding.
singleWhere Inherited ( bool test(T element) ) → Future<List<int>>
Finds the single element in this stream matching test.
drain Inherited ( [futureValue] ) → Future
Discards all data on the stream, but signals when it's done or an error occured.
close Inherited ( ) → Future
Close the target consumer.
asyncMap Inherited ( dynamic convert(T event) ) → Stream
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
toList Inherited ( ) → Future<List<List<int>>>
Collects the data of this stream in a List.
asBroadcastStream Inherited ( {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.