A TCP connection.

Asocket connection connects alocal socket to aremote socket.Data, asUint8Lists, is received by the local socket and madeavailable by theread method, and can be sent to the remote socketthrough thewrite method.

TheStream interface of this class provides event notification about whena certain change has happened, for example when data has become available(RawSocketEvent.read) or when the remote end has stopped listening(RawSocketEvent.closed).

Implemented types

• Stream<RawSocketEvent>

Implementers

• RawSecureSocket

Properties

address→InternetAddress

TheInternetAddress used to connect this socket.

no setter

first→Future<RawSocketEvent>

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<RawSocketEvent>

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

readEventsEnabled↔bool

Set or get, if theRawSocket should listen forRawSocketEvent.readandRawSocketEvent.readClosed events. Default istrue.

getter/setter pair

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<RawSocketEvent>

The single element of this stream.

no setterinherited

writeEventsEnabled↔bool

Set or get, if theRawSocket should listen forRawSocketEvent.writeevents. Default istrue.This is a one-shot listener, and writeEventsEnabled must be setto true again to receive another write event.

getter/setter pair

Methods

any(booltest(RawSocketEventelement))→Future<bool>

Checks whethertest accepts any element provided by this stream.

inherited

asBroadcastStream({voidonListen(StreamSubscription<RawSocketEvent>subscription)?,voidonCancel(StreamSubscription<RawSocketEvent>subscription)?})→Stream<RawSocketEvent>

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

inherited

asyncExpand<E>(Stream<E>?convert(RawSocketEventevent))→Stream<E>

Transforms each element into a sequence of asynchronous events.

inherited

asyncMap<E>(FutureOr<E>convert(RawSocketEventevent))→Stream<E>

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

inherited

available()→int

The number of received and non-read bytes in the socket that can be read.

cast<R>()→Stream<R>

Adapt this stream to be aStream<R>.

inherited

close()→Future<RawSocket>

Closes the socket.

contains(Object?needle)→Future<bool>

Returns whetherneedle occurs in the elements provided by this stream.

inherited

distinct([boolequals(RawSocketEventprevious,RawSocketEventnext)?])→Stream<RawSocketEvent>

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<RawSocketEvent>

Returns the value of theindexth data event of this stream.

inherited

every(booltest(RawSocketEventelement))→Future<bool>

Checks whethertest accepts all elements provided by this stream.

inherited

expand<S>(Iterable<S>convert(RawSocketEventelement))→Stream<S>

Transforms each element of this stream into a sequence of elements.

inherited

firstWhere(booltest(RawSocketEventelement), {RawSocketEventorElse()?})→Future<RawSocketEvent>

Finds the first element of this stream matchingtest.

inherited

fold<S>(SinitialValue,Scombine(Sprevious,RawSocketEventelement))→Future<S>

Combines a sequence of values by repeatedly applyingcombine.

inherited

forEach(voidaction(RawSocketEventelement))→Future<void>

Executesaction on each element of this stream.

inherited

getRawOption(RawSocketOptionoption)→Uint8List

Reads low level information about theRawSocket.

handleError(FunctiononError, {booltest(dynamicerror)?})→Stream<RawSocketEvent>

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(RawSocketEventelement), {RawSocketEventorElse()?})→Future<RawSocketEvent>

Finds the last element in this stream matchingtest.

inherited

listen(voidonData(RawSocketEventevent)?, {Function?onError,voidonDone()?,bool?cancelOnError})→StreamSubscription<RawSocketEvent>

Adds a subscription to this stream.

inherited

map<S>(Sconvert(RawSocketEventevent))→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<RawSocketEvent>streamConsumer)→Future

Pipes the events of this stream intostreamConsumer.

inherited

read([int?len])→Uint8List?

Read up tolen bytes from the socket.

readMessage([int?count])→SocketMessage?

Reads a message containing up tocount bytes from the socket.

reduce(RawSocketEventcombine(RawSocketEventprevious,RawSocketEventelement))→Future<RawSocketEvent>

Combines a sequence of values by repeatedly applyingcombine.

inherited

sendMessage(List<SocketControlMessage>controlMessages,List<int>data, [intoffset =0,int?count])→int

Writes socket control messages and data bytes to the socket.

setOption(SocketOptionoption,boolenabled)→bool

Customize theRawSocket.

setRawOption(RawSocketOptionoption)→ void

Customizes theRawSocket.

shutdown(SocketDirectiondirection)→ void

Shuts down the socket in thedirection.

singleWhere(booltest(RawSocketEventelement), {RawSocketEventorElse()?})→Future<RawSocketEvent>

Finds the single element in this stream matchingtest.

inherited

skip(intcount)→Stream<RawSocketEvent>

Skips the firstcount data events from this stream.

inherited

skipWhile(booltest(RawSocketEventelement))→Stream<RawSocketEvent>

Skip data events from this stream while they are matched bytest.

inherited

take(intcount)→Stream<RawSocketEvent>

Provides at most the firstcount data events of this stream.

inherited

takeWhile(booltest(RawSocketEventelement))→Stream<RawSocketEvent>

Forwards data events whiletest is successful.

inherited

timeout(DurationtimeLimit, {voidonTimeout(EventSink<RawSocketEvent>sink)?})→Stream<RawSocketEvent>

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

inherited

toList()→Future<List<RawSocketEvent>>

Collects all elements of this stream in aList.

inherited

toSet()→Future<Set<RawSocketEvent>>

Collects the data of this stream in aSet.

inherited

toString()→String

A string representation of this object.

inherited

transform<S>(StreamTransformer<RawSocketEvent,S>streamTransformer)→Stream<S>

AppliesstreamTransformer to this stream.

inherited

where(booltest(RawSocketEventevent))→Stream<RawSocketEvent>

Creates a new stream from this stream that discards some elements.

inherited

write(List<int>buffer, [intoffset =0,int?count])→int

Writes up tocount bytes of the buffer fromoffset buffer offset tothe socket.

Operators

operator ==(Objectother)→bool

The equality operator.

inherited

Static Methods

connect(dynamichost,intport, {dynamicsourceAddress,intsourcePort =0,Duration?timeout})→Future<RawSocket>

Creates a new socket connection to the host and port.

startConnect(dynamichost,intport, {dynamicsourceAddress,intsourcePort =0})→Future<ConnectionTask<RawSocket>>

Likeconnect, but returns aFuture that completes with aConnectionTask that can be cancelled if theRawSocket is nolonger needed.