SecureSocket class abstract interface

A TCP socket using TLS and SSL.

See Socket for more information.

Implemented types
Available Extensions

Properties

address → InternetAddress
The InternetAddress used to connect this socket.
no setterinherited
done → Future
A future that will complete when the consumer closes, or when an error occurs.
no setterinherited
encoding ↔ Encoding
The Encoding 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
peerCertificate → X509Certificate?
The peer certificate for a connected SecureSocket.
no setter
port → int
The port used by this socket.
no setterinherited
remoteAddress → InternetAddress
The remote InternetAddress connected to by this socket.
no setterinherited
remotePort → int
The remote port connected to by this socket.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedProtocol → String?
The protocol which was selected during ALPN protocol negotiation.
no setter
single → Future<Uint8List>
The single element of this stream.
no setterinherited

Methods

add(List<int> data) → void
Adds byte data to the target consumer, ignoring encoding.
inherited
addError(Object 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.
inherited
any(bool test(Uint8List element)) → Future<bool>
Checks whether test accepts any element provided by this stream.
inherited
asBroadcastStream({void onListen(StreamSubscription<Uint8List> subscription)?, void onCancel(StreamSubscription<Uint8List> subscription)?}) → Stream<Uint8List>
Returns a multi-subscription stream that produces the same events as this.
inherited
asyncExpand<E>(Stream<E>? convert(Uint8List event)) → Stream<E>
Transforms each element into a sequence of asynchronous events.
inherited
asyncMap<E>(FutureOr<E> convert(Uint8List event)) → Stream<E>
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
inherited
cast<R>() → Stream<R>
Adapt this stream to be a Stream<R>.
inherited
close() → Future
Close the target consumer.
inherited
contains(Object? needle) → Future<bool>
Returns whether needle occurs in the elements provided by this stream.
inherited
destroy() → void
Destroys the socket in both directions.
inherited
distinct([bool equals(Uint8List previous, Uint8List next)?]) → 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 error occurred.
inherited
elementAt(int index) → Future<Uint8List>
Returns the value of the indexth data event of this stream.
inherited
every(bool test(Uint8List element)) → Future<bool>
Checks whether test accepts all elements provided by this stream.
inherited
expand<S>(Iterable<S> convert(Uint8List element)) → Stream<S>
Transforms each element of this stream into a sequence of elements.
inherited
firstWhere(bool test(Uint8List element), {Uint8List orElse()?}) → Future<Uint8List>
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 underlying StreamConsumer.
inherited
fold<S>(S initialValue, S combine(S previous, Uint8List element)) → Future<S>
Combines a sequence of values by repeatedly applying combine.
inherited
forEach(void action(Uint8List element)) → Future<void>
Executes action on each element of this stream.
inherited
getRawOption(RawSocketOption option) → Uint8List
Reads low level information about the RawSocket.
inherited
handleError(Function onError, {bool test(dynamic error)?}) → Stream<Uint8List>
Creates a wrapper Stream that intercepts some errors from this stream.
inherited
join([String separator = ""]) → Future<String>
Combines the string representation of elements into a single string.
inherited
lastWhere(bool test(Uint8List element), {Uint8List orElse()?}) → Future<Uint8List>
Finds the last element in this stream matching test.
inherited
listen(void onData(Uint8List event)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<Uint8List>
Adds a subscription to this stream.
inherited
map<S>(S convert(Uint8List event)) → Stream<S>
Transforms each element of this stream into a new stream event.
inherited
noSuchMethod(Invocation invocation) → 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(Uint8List combine(Uint8List previous, Uint8List element)) → Future<Uint8List>
Combines a sequence of values by repeatedly applying combine.
inherited
renegotiate({bool useSessionCache = true, bool requestClientCertificate = false, bool requireClientCertificate = false}) → void
Does nothing.
setOption(SocketOption option, bool enabled) → bool
Customizes the RawSocket.
inherited
setRawOption(RawSocketOption option) → void
Customizes the RawSocket.
inherited
singleWhere(bool test(Uint8List element), {Uint8List orElse()?}) → Future<Uint8List>
Finds the single element in this stream matching test.
inherited
skip(int count) → Stream<Uint8List>
Skips the first count data events from this stream.
inherited
skipWhile(bool test(Uint8List element)) → Stream<Uint8List>
Skip data events from this stream while they are matched by test.
inherited
take(int count) → Stream<Uint8List>
Provides at most the first count data events of this stream.
inherited
takeWhile(bool test(Uint8List element)) → Stream<Uint8List>
Forwards data events while test is successful.
inherited
timeout(Duration timeLimit, {void onTimeout(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 a List.
inherited
toSet() → Future<Set<Uint8List>>
Collects the data of this stream in a Set.
inherited
toString() → String
A string representation of this object.
inherited
transform<S>(StreamTransformer<Uint8List, S> streamTransformer) → Stream<S>
Applies streamTransformer to this stream.
inherited
where(bool test(Uint8List event)) → Stream<Uint8List>
Creates a new stream from this stream that discards some elements.
inherited
write(Object? object) → void
Converts object 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? object = ""]) → void
Converts object to a String by invoking Object.toString and writes the result to this, followed by a newline.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

connect(dynamic host, int port, {SecurityContext? context, bool onBadCertificate(X509Certificate certificate)?, void keyLog(String line)?, List<String>? supportedProtocols, Duration? timeout}) → Future<SecureSocket>
Constructs a new secure client socket and connects it to the given host on port port.
override
secure(Socket socket, {dynamic host, SecurityContext? context, bool onBadCertificate(X509Certificate certificate)?, void keyLog(String line)?, List<String>? supportedProtocols}) → Future<SecureSocket>
Initiates TLS on an existing connection.
secureServer(Socket socket, SecurityContext? context, {List<int>? bufferedData, bool requestClientCertificate = false, bool requireClientCertificate = false, List<String>? supportedProtocols}) → Future<SecureSocket>
Initiates TLS on an existing server connection.
startConnect(dynamic host, int port, {SecurityContext? context, bool onBadCertificate(X509Certificate certificate)?, void keyLog(String line)?, List<String>? supportedProtocols}) → Future<ConnectionTask<SecureSocket>>
Like connect, but returns a Future that completes with a ConnectionTask that can be cancelled if the SecureSocket is no longer needed.
override