A TCP connection between two sockets.
Asocket connection connects alocal socket to aremote socket.Data, asUint8Lists, is received by the local socket, made availableby theStream interface of this class, and can be sent to the remotesocket through theIOSink interface of this class.
Transmission of the data sent through theIOSink interface may bedelayed unlessSocketOption.tcpNoDelay is set withSocket.setOption.
- Implemented types
- Implementers
Properties
- address→InternetAddress
- TheInternetAddress used to connect this socket.no setter
- done→Future
- A future that will complete when the consumer closes, or when anerror occurs.no setteroverride
- encoding↔Encoding
- TheEncoding used when writing strings.getter/setter pairinherited
- first→Future<
Uint8List> - The first element of this stream.no setterinherited
- hashCode→int
- The hash code for this object.no setterinherited
- isBroadcast→bool
- Whether this stream is a broadcast stream.no setterinherited
- isEmpty→Future<
bool> - Whether this stream contains any elements.no setterinherited
- last→Future<
Uint8List> - The last element of this stream.no setterinherited
- length→Future<
int> - The number of elements in this stream.no setterinherited
- port→int
- The port used by this socket.no setter
- remoteAddress→InternetAddress
- The remoteInternetAddress connected to by this socket.no setter
- remotePort→int
- The remote port connected to by this socket.no setter
- runtimeType→Type
- A representation of the runtime type of the object.no setterinherited
- single→Future<
Uint8List> - The single element of this stream.no setterinherited
Methods
- add(
List< int> data)→ void - Adds byte
datato the target consumer, ignoringencoding.inherited - addError(
Objecterror, [StackTrace?stackTrace])→ void - Unsupported operation on sockets.override
- addStream(
Stream< List< stream)→Futureint> > - Adds all elements of the given
stream.inherited - any(
booltest(Uint8Listelement))→Future< bool> - Checks whether
testaccepts any element provided by this stream.inherited - asBroadcastStream(
{voidonListen(StreamSubscription< Uint8List> subscription)?,voidonCancel(StreamSubscription<Uint8List> subscription)?})→Stream<Uint8List> - Returns a multi-subscription stream that produces the same events as this.inherited
- asyncExpand<
E> (Stream< E> ?convert(Uint8Listevent))→Stream<E> - Transforms each element into a sequence of asynchronous events.inherited
- asyncMap<
E> (FutureOr< E> convert(Uint8Listevent))→Stream<E> - Creates a new stream with each data event of this stream asynchronouslymapped to a new event.inherited
- cast<
R> ()→Stream< R> - Adapt this stream to be a
Stream<R>.inherited - close(
)→Future - Close the target consumer.override
- contains(
Object?needle)→Future< bool> - Returns whether
needleoccurs in the elements provided by this stream.inherited - destroy(
)→ void - Destroys the socket in both directions.
- distinct(
[boolequals(Uint8Listprevious,Uint8Listnext)?])→Stream< Uint8List> - 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 erroroccurred.inherited
- elementAt(
intindex)→Future< Uint8List> - Returns the value of the
indexth data event of this stream.inherited - every(
booltest(Uint8Listelement))→Future< bool> - Checks whether
testaccepts all elements provided by this stream.inherited - expand<
S> (Iterable< S> convert(Uint8Listelement))→Stream<S> - Transforms each element of this stream into a sequence of elements.inherited
- firstWhere(
booltest(Uint8Listelement), {Uint8ListorElse()?})→Future< Uint8List> - Finds the first element of this stream matching
test.inherited - flush(
)→Future - Returns aFuture that completes once all buffered data is accepted by theunderlyingStreamConsumer.inherited
- fold<
S> (SinitialValue,Scombine(Sprevious,Uint8Listelement))→Future< S> - Combines a sequence of values by repeatedly applying
combine.inherited - forEach(
voidaction(Uint8Listelement))→Future< void> - Executes
actionon each element of this stream.inherited - getRawOption(
RawSocketOptionoption)→Uint8List - Reads low level information about theRawSocket.
- handleError(
FunctiononError, {booltest(dynamicerror)?})→Stream< Uint8List> - Creates a wrapper Stream that intercepts some errors from this stream.inherited
- join(
[Stringseparator =""])→Future< String> - Combines the string representation of elements into a single string.inherited
- lastWhere(
booltest(Uint8Listelement), {Uint8ListorElse()?})→Future< Uint8List> - Finds the last element in this stream matching
test.inherited - listen(
voidonData(Uint8Listevent)?, {Function?onError,voidonDone()?,bool?cancelOnError})→StreamSubscription< Uint8List> - Adds a subscription to this stream.inherited
- map<
S> (Sconvert(Uint8Listevent))→Stream< S> - Transforms each element of this stream into a new stream event.inherited
- noSuchMethod(
Invocationinvocation)→ dynamic - Invoked when a nonexistent method or property is accessed.inherited
- pipe(
StreamConsumer< Uint8List> streamConsumer)→Future - Pipes the events of this stream into
streamConsumer.inherited - reduce(
Uint8Listcombine(Uint8Listprevious,Uint8Listelement))→Future< Uint8List> - Combines a sequence of values by repeatedly applying
combine.inherited - setOption(
SocketOptionoption,boolenabled)→bool - Customizes theRawSocket.
- setRawOption(
RawSocketOptionoption)→ void - Customizes theRawSocket.
- singleWhere(
booltest(Uint8Listelement), {Uint8ListorElse()?})→Future< Uint8List> - Finds the single element in this stream matching
test.inherited - skip(
intcount)→Stream< Uint8List> - Skips the first
countdata events from this stream.inherited - skipWhile(
booltest(Uint8Listelement))→Stream< Uint8List> - Skip data events from this stream while they are matched by
test.inherited - take(
intcount)→Stream< Uint8List> - Provides at most the first
countdata events of this stream.inherited - takeWhile(
booltest(Uint8Listelement))→Stream< Uint8List> - Forwards data events while
testis successful.inherited - timeout(
DurationtimeLimit, {voidonTimeout(EventSink< Uint8List> sink)?})→Stream<Uint8List> - Creates a new stream with the same events as this stream.inherited
- toList(
)→Future< List< Uint8List> > - Collects all elements of this stream in aList.inherited
- toSet(
)→Future< Set< Uint8List> > - Collects the data of this stream in aSet.inherited
- toString(
)→String - A string representation of this object.inherited
- transform<
S> (StreamTransformer< Uint8List,S> streamTransformer)→Stream<S> - Applies
streamTransformerto this stream.inherited - where(
booltest(Uint8Listevent))→Stream< Uint8List> - Creates a new stream from this stream that discards some elements.inherited
- write(
Object?object)→ void - Converts
objectto a String by invokingObject.toString andadds the encoding of the result to the target consumer.inherited - writeAll(
Iterableobjects, [Stringseparator =""])→ void - Iterates over the given
objectsandwrites them in sequence.inherited - writeCharCode(
intcharCode)→ void - Writes the character of
charCode.inherited - writeln(
[Object?object =""])→ void - Converts
objectto a String by invokingObject.toString andwrites the result tothis, followed by a newline.inherited
Operators
- operator ==(
Objectother)→bool - The equality operator.inherited
Static Methods
- connect(
dynamichost,intport, {dynamicsourceAddress,intsourcePort =0,Duration?timeout})→Future< Socket> - Creates a new socket connection to the host and port and returns aFuturethat will complete with either aSocket once connected or an errorif the host-lookup or connection failed.
- startConnect(
dynamichost,intport, {dynamicsourceAddress,intsourcePort =0})→Future< ConnectionTask< Socket> > - Likeconnect, but returns aFuture that completes with aConnectionTask that can be cancelled if theSocket is nolonger needed.