SecureSocket abstract 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.

Implements

Socket

Static Methods

connect(host, int port, { SecurityContext context, bool onBadCertificate(X509Certificate certificate), List<String> supportedProtocols }) → Future<SecureSocket>: 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, { 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.

Properties

peerCertificate → X509Certificate 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.
selectedProtocol → String read-only: The protocol which was selected during ALPN protocol negotiation.
address → InternetAddress read-only, inherited: Returns the InternetAddress used to connect this socket.
done → Future<Socket> read-only, inherited
encoding → Encoding read / write, inherited: The Encoding used when writing strings. Depending on the underlying consumer this property might be mutable.
first → Future<List<int>> read-only, inherited: Returns the first element of the stream.
hashCode → int read-only, inherited: The hash code for this object.
isBroadcast → bool read-only, inherited: Whether this stream is a broadcast stream.
isEmpty → Future<bool> read-only, inherited: Reports whether this stream contains any elements.
last → Future<List<int>> read-only, inherited: Returns the last element of the stream.
length → Future<int> read-only, inherited: Counts the elements in the stream.
port → int read-only, inherited: Returns the port used by this socket.
remoteAddress → InternetAddress read-only, inherited: Returns the remote InternetAddress connected to by this socket.
remotePort → int read-only, inherited: Returns the remote port connected to by this socket.
runtimeType → Type read-only, inherited: A representation of the runtime type of the object.
single → Future<List<int>> read-only, inherited: Returns the single element.

Operators

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

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(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<List<int>> inherited: Returns a multi-subscription stream that produces the same events as this.
asyncExpand<E>(Stream<E> convert(T event)) → Stream<E> inherited: Creates a new stream with the events of a stream per original event.
asyncMap<E>(dynamic convert(T event)) → Stream<E> inherited: Creates a new stream with each data event of this stream asynchronously mapped to a new event.
close() → Future<Socket> inherited: Close the target consumer.
contains(Object needle) → Future<bool> inherited: Checks 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<List<int>> inherited: Skips data events if they are equal to the previous data event.
drain<E>([E futureValue ]) → Future<E> inherited: Discards all data on the stream, but signals when it's done or an error occurred.
elementAt(int index) → Future<List<int>> 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 value)) → Stream<S> inherited: Creates a new stream from this stream that converts each element into zero or more events.
firstWhere(bool test(T element), { Object defaultValue() }) → Future 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: Reduces a sequence of values by repeatedly applying combine.
forEach(void action(T element)) → Future inherited: Executes action on each data event of the stream.
handleError(Function onError, { bool test(error) }) → Stream<List<int>> inherited: Creates a wrapper Stream that intercepts some errors from this stream.
join([String separator = "" ]) → Future<String> inherited: Collects string of data events' string representations.
lastWhere(bool test(T element), { Object defaultValue() }) → Future inherited: Finds the last element in this stream matching test.
listen(void onData(T event), { Function onError, void onDone(), bool cancelOnError }) → StreamSubscription<List<int>> inherited: Adds a subscription to this stream.
map<S>(S convert(T event)) → Stream<S> inherited: Creates a new stream that converts each element of this stream to a new value using the convert function.
noSuchMethod(Invocation invocation) → dynamic inherited: Invoked when a non-existent method or property is accessed.
pipe(StreamConsumer<List<int>> streamConsumer) → Future inherited: Pipe the events of this stream into streamConsumer.
reduce(List<int> combine(T previous, T element)) → Future<List<int>> inherited: Reduces 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.
singleWhere(bool test(T element)) → Future<List<int>> inherited: Finds the single element in this stream matching test.
skip(int count) → Stream<List<int>> inherited: Skips the first count data events from this stream.
skipWhile(bool test(T element)) → Stream<List<int>> inherited: Skip data events from this stream while they are matched by test.
take(int count) → Stream<List<int>> inherited: Provides at most the first count data events of this stream.
takeWhile(bool test(T element)) → Stream<List<int>> inherited: Forwards data events while test is successful.
timeout(Duration timeLimit, { void onTimeout(EventSink<T> sink) }) → Stream<List<int>> inherited: Creates a new stream with the same events as this stream.
toList() → Future<List<List<int>>> inherited: Collects the data of this stream in a List.
toSet() → Future<Set<List<int>>> inherited: Collects the data of this stream in a Set.
toString() → String inherited: Returns a string representation of this object.
transform<S>(StreamTransformer<List<int>, S> streamTransformer) → Stream<S> inherited: Chains this stream as the input of the provided StreamTransformer.
where(bool test(T event)) → Stream<List<int>> inherited: Creates a new stream from this stream that discards some data events.
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.

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