W3cubDocs

/Dart 2

SecureSocket class

A high-level class for communicating securely over a TCP socket, using TLS and SSL. The SecureSocket exposes both a Stream and an IOSink interface, making it ideal for using together with other Streams.

Implemented types

Properties

peerCertificateX509Certificate
read-only
Get the peer certificate for a connected SecureSocket. If this SecureSocket is the server end of a secure socket connection, peerCertificate will return the client certificate, or null, if no client certificate was received. If it is the client end, peerCertificate will return the server's certificate.
selectedProtocolString
read-only
The protocol which was selected during ALPN protocol negotiation. [...]
addressInternetAddress
read-only, inherited
Returns the InternetAddress used to connect this socket.
doneFuture
read-only, inherited
Get a future that will complete when the consumer closes, or when an error occurs. This future is identical to the future returned by close.
encodingEncoding
read / write, inherited
The Encoding used when writing strings. Depending on the underlying consumer this property might be mutable.
firstFuture<Uint8List>
read-only, inherited
The first element of this stream. [...]
hashCodeint
read-only, inherited
The hash code for this object. [...]
isBroadcastbool
read-only, inherited
Whether this stream is a broadcast stream.
isEmptyFuture<bool>
read-only, inherited
Whether this stream contains any elements. [...]
lastFuture<Uint8List>
read-only, inherited
The last element of this stream. [...]
lengthFuture<int>
read-only, inherited
The number of elements in this stream. [...]
portint
read-only, inherited
Returns the port used by this socket.
remoteAddressInternetAddress
read-only, inherited
Returns the remote InternetAddress connected to by this socket.
remotePortint
read-only, inherited
Returns the remote port connected to by this socket.
runtimeTypeType
read-only, inherited
A representation of the runtime type of the object.
singleFuture<Uint8List>
read-only, inherited
The single element of this stream. [...]

Methods

renegotiate({bool useSessionCache: true, bool requestClientCertificate: false, bool requireClientCertificate: false }) → void
Renegotiate an existing secure connection, renewing the session keys and possibly changing the connection properties. [...]
add(List<int> data) → void
inherited
Adds byte data to the target consumer, ignoring encoding. [...]
addError(Object error, [ StackTrace stackTrace ]) → void
inherited
Passes the error to the target consumer as an error event. [...]
addStream(Stream<List<int>> stream) → Future
inherited
Adds all elements of the given stream to this. [...]
any(bool test(T element)) → Future<bool>
inherited
Checks whether test accepts any element provided by this stream. [...]
asBroadcastStream({void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription) }) → Stream<Uint8List>
inherited
Returns a multi-subscription stream that produces the same events as this. [...]
asyncExpand<E>(Stream<E> convert(T event)) → Stream<E>
inherited
Transforms each element into a sequence of asynchronous events. [...]
asyncMap<E>(FutureOr<E> convert(T event)) → Stream<E>
inherited
Creates a new stream with each data event of this stream asynchronously mapped to a new event. [...]
cast<R>() → Stream<R>
inherited
Adapt this stream to be a Stream<R>. [...]
close() → Future
inherited
Close the target consumer. [...]
contains(Object needle) → Future<bool>
inherited
Returns whether needle occurs in the elements provided by this stream. [...]
destroy() → void
inherited
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<Uint8List>
inherited
Skips data events if they are equal to the previous data event. [...]
drain<E>([E futureValue ]) → Future<E>
inherited
Discards all data on this stream, but signals when it is done or an error occurred. [...]
elementAt(int index) → Future<Uint8List>
inherited
Returns the value of the indexth data event of this stream. [...]
every(bool test(T element)) → Future<bool>
inherited
Checks whether test accepts all elements provided by this stream. [...]
expand<S>(Iterable<S> convert(T element)) → Stream<S>
inherited
Transforms each element of this stream into a sequence of elements. [...]
firstWhere(bool test(T element), { Uint8List orElse() }) → Future<Uint8List>
inherited
Finds the first element of this stream matching test. [...]
flush() → Future
inherited
Returns a Future that completes once all buffered data is accepted by the underlying StreamConsumer. [...]
fold<S>(S initialValue, S combine(S previous, T element)) → Future<S>
inherited
Combines a sequence of values by repeatedly applying combine. [...]
forEach(void action(T element)) → Future
inherited
Executes action on each element of this stream. [...]
getRawOption(RawSocketOption option) → Uint8List
inherited
Use getRawOption to get low level information about the RawSocket. See RawSocketOption for available options. [...]
handleError(Function onError, { bool test(dynamic error) }) → Stream<Uint8List>
inherited
Creates a wrapper Stream that intercepts some errors from this stream. [...]
join([String separator = "" ]) → Future<String>
inherited
Combines the string representation of elements into a single string. [...]
lastWhere(bool test(T element), { Uint8List orElse() }) → Future<Uint8List>
inherited
Finds the last element in this stream matching test. [...]
listen(void onData(T event), { Function onError, void onDone(), bool cancelOnError }) → StreamSubscription<Uint8List>
inherited
Adds a subscription to this stream. [...]
map<S>(S convert(T event)) → Stream<S>
inherited
Transforms each element of this stream into a new stream event. [...]
noSuchMethod(Invocation invocation) → dynamic
inherited
Invoked when a non-existent method or property is accessed. [...]
pipe(StreamConsumer<Uint8List> streamConsumer) → Future
inherited
Pipes the events of this stream into streamConsumer. [...]
reduce(Uint8List combine(T previous, T element)) → Future<Uint8List>
inherited
Combines a sequence of values by repeatedly applying combine. [...]
setOption(SocketOption option, bool enabled) → bool
inherited
Use setOption to customize the RawSocket. See SocketOption for available options. [...]
setRawOption(RawSocketOption option) → void
inherited
Use setRawOption to customize the RawSocket. See RawSocketOption for available options. [...]
singleWhere(bool test(T element), { Uint8List orElse() }) → Future<Uint8List>
inherited
Finds the single element in this stream matching test. [...]
skip(int count) → Stream<Uint8List>
inherited
Skips the first count data events from this stream. [...]
skipWhile(bool test(T element)) → Stream<Uint8List>
inherited
Skip data events from this stream while they are matched by test. [...]
take(int count) → Stream<Uint8List>
inherited
Provides at most the first count data events of this stream. [...]
takeWhile(bool test(T element)) → Stream<Uint8List>
inherited
Forwards data events while test is successful. [...]
timeout(Duration timeLimit, { void onTimeout(EventSink<T> sink) }) → Stream<Uint8List>
inherited
Creates a new stream with the same events as this stream. [...]
toList() → Future<List<Uint8List>>
inherited
Collects all elements of this stream in a List. [...]
toSet() → Future<Set<Uint8List>>
inherited
Collects the data of this stream in a Set. [...]
toString() → String
inherited
Returns a string representation of this object.
transform<S>(StreamTransformer<Uint8List, S> streamTransformer) → Stream<S>
inherited
Applies streamTransformer to this stream. [...]
where(bool test(T event)) → Stream<Uint8List>
inherited
Creates a new stream from this stream that discards some elements. [...]
write(Object obj) → void
inherited
Converts obj to a String by invoking Object.toString and adds the encoding of the result to the target consumer. [...]
writeAll(Iterable objects, [ String separator = "" ]) → void
inherited
Iterates over the given objects and writes them in sequence. [...]
writeCharCode(int charCode) → void
inherited
Writes the character of charCode. [...]
writeln([Object obj = "" ]) → void
inherited
Converts obj to a String by invoking Object.toString and writes the result to this, followed by a newline. [...]

Operators

operator ==(dynamic other) → bool
inherited
The equality operator. [...]

Static Methods

connect(dynamic host, int port, { SecurityContext context, bool onBadCertificate(X509Certificate certificate), List<String> supportedProtocols, Duration timeout }) → Future<SecureSocket>
override
Constructs a new secure client socket and connects it to the given host on port port. The returned Future will complete with a SecureSocket that is connected and ready for subscription. [...]
secure(Socket socket, { dynamic host, SecurityContext context, bool onBadCertificate(X509Certificate certificate) }) → Future<SecureSocket>
Takes an already connected socket and starts client side TLS handshake to make the communication secure. When the returned future completes the SecureSocket has completed the TLS handshake. Using this function requires that the other end of the connection is prepared for TLS handshake. [...]
secureServer(Socket socket, SecurityContext context, { List<int> bufferedData, bool requestClientCertificate: false, bool requireClientCertificate: false, List<String> supportedProtocols }) → Future<SecureSocket>
Takes an already connected socket and starts server side TLS handshake to make the communication secure. When the returned future completes the SecureSocket has completed the TLS handshake. Using this function requires that the other end of the connection is going to start the TLS handshake. [...]
startConnect(dynamic host, int port, { SecurityContext context, bool onBadCertificate(X509Certificate certificate), List<String> supportedProtocols }) → Future<ConnectionTask<SecureSocket>>
override
Like connect, but returns a Future that completes with a ConnectionTask that can be cancelled if the SecureSocket is no longer needed.

© 2012 the Dart project authors
Licensed under the Creative Commons Attribution-ShareAlike License v4.0.
https://api.dart.dev/stable/2.5.0/dart-io/SecureSocket-class.html