RawSecureSocket class

RawSecureSocket provides a secure (SSL or TLS) network connection. Client connections to a server are provided by calling RawSecureSocket.connect. A secure server, created with RawSecureServerSocket, also returns RawSecureSocket objects representing the server end of a secure connection. The certificate provided by the server is checked using the certificate database provided in SecureSocket.initialize, and/or the default built-in root certificates.

RawSecureSocket provides a secure (SSL or TLS) network connection. Client connections to a server are provided by calling RawSecureSocket.connect. A secure server, created with RawSecureServerSocket, also returns RawSecureSocket objects representing the server end of a secure connection. The certificate provided by the server is checked using the certificate database provided in SecureSocket.initialize, and/or the default built-in root certificates.

Implements

Constructors

RawSecureSocket()

Static Methods

connect(host, int port, {bool sendClientCertificate: false, String certificateName, bool onBadCertificate(X509Certificate certificate), List<String> supportedProtocols}) → Future<RawSecureSocket>
Constructs a new secure client socket and connect it to the given host on the given port. The returned Future is completed with the RawSecureSocket when it is connected and ready for subscription.
secure(RawSocket socket, {StreamSubscription subscription, host, bool sendClientCertificate: false, String certificateName, bool onBadCertificate(X509Certificate certificate), List<String> supportedProtocols}) → Future<RawSecureSocket>
Takes an already connected socket and starts client side TLS handshake to make the communication secure. When the returned future completes the RawSecureSocket has completed the TLS handshake. Using this function requires that the other end of the connection is prepared for TLS handshake.
secureServer(RawSocket socket, String certificateName, {StreamSubscription subscription, List<int> bufferedData, bool requestClientCertificate: false, bool requireClientCertificate: false, List<String> supportedProtocols}) → Future<RawSecureSocket>
Takes an already connected socket and starts server side TLS handshake to make the communication secure. When the returned future completes the RawSecureSocket has completed the TLS handshake. Using this function requires that the other end of the connection is going to start the TLS handshake.

Instance Properties

peerCertificate X509Certificate
read-only
selectedProtocol String
read-only
writeEventsEnabled bool Inherited
read / write
Set or get, if the RawSocket should listen for RawSocketEvent.WRITE events. Default is true. This is a one-shot listener, and writeEventsEnabled must be set to true again to receive another write event.
remotePort int Inherited
read-only
last Future<RawSocketEvent> Inherited
read-only
single Future<RawSocketEvent> Inherited
read-only
length Future<int> Inherited
read-only
isEmpty Future<bool> Inherited
read-only
readEventsEnabled bool Inherited
read / write
Set or get, if the RawSocket should listen for RawSocketEvent.READ events. Default is true.
isBroadcast bool Inherited
read-only
remoteAddress InternetAddress Inherited
read-only
address InternetAddress Inherited
read-only
port int Inherited
read-only
first Future<RawSocketEvent> Inherited
read-only

Instance 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.
take(int count) → Stream<RawSocketEvent> Inherited
Provides at most the first n values of this stream.
map(dynamic convert(T event)) → Stream Inherited
Creates a new stream that converts each element of this stream to a new value using the convert function.
listen(void onData(T event), {Function onError, void onDone(), bool cancelOnError}) → StreamSubscription<RawSocketEvent> Inherited
Adds a subscription to this stream.
timeout(Duration timeLimit, {void onTimeout(EventSink sink)}) → Stream Inherited
Creates a new stream with the same events as this stream.
distinct([bool equals(T previous, T next)]) → Stream<RawSocketEvent> Inherited
Skips data events if they are equal to the previous data event.
toSet() → Future<Set<RawSocketEvent>> Inherited
Collects the data of this stream in a Set.
forEach(void action(T element)) → Future Inherited
Executes action on each data event of the stream.
skipWhile(bool test(T element)) → Stream<RawSocketEvent> Inherited
Skip data events from this stream while they are matched by test.
join([String separator = ""]) → Future<String> Inherited
Collects string of data events' string representations.
setOption(SocketOption option, bool enabled) → bool Inherited
Use setOption to customize the RawSocket. See SocketOption for available options.
lastWhere(bool test(T element), {Object defaultValue()}) → Future Inherited
Finds the last element in this stream matching test.
handleError(Function onError, {bool test(error)}) → Stream<RawSocketEvent> Inherited
Creates a wrapper Stream that intercepts some errors from this stream.
reduce(T combine(T previous, T element)) → Future<RawSocketEvent> Inherited
Reduces a sequence of values by repeatedly applying combine.
transform(StreamTransformer<RawSocketEvent> streamTransformer) → Stream Inherited
Chains this stream as the input of the provided StreamTransformer.
every(bool test(T element)) → Future<bool> Inherited
Checks whether test accepts all elements provided by this stream.
any(bool test(T element)) → Future<bool> Inherited
Checks whether test accepts any element provided by this stream.
where(bool test(T event)) → Stream<RawSocketEvent> Inherited
Creates a new stream from this stream that discards some data events.
skip(int count) → Stream<RawSocketEvent> Inherited
Skips the first count data events from this stream.
expand(Iterable convert(T value)) → Stream Inherited
Creates a new stream from this stream that converts each element into zero or more events.
elementAt(int index) → Future<RawSocketEvent> Inherited
Returns the value of the indexth data event of this stream.
pipe(StreamConsumer<RawSocketEvent> streamConsumer) → Future Inherited
Pipe the events of this stream into streamConsumer.
shutdown(SocketDirection direction) → void Inherited
Shutdown the socket in the direction. Calling shutdown will never throw an exception and calling it several times is supported. Calling shutdown with either SocketDirection.BOTH or SocketDirection.RECEIVE can result in a RawSocketEvent.READ_CLOSED event.
read([int len]) → List<int> Inherited
Read up to len bytes from the socket. This function is non-blocking and will only return data if data is available. The number of bytes read can be less then len if fewer bytes are available for immediate reading. If no data is available null is returned.
takeWhile(bool test(T element)) → Stream<RawSocketEvent> Inherited
Forwards data events while test is successful.
write(List<int> buffer, [int offset, int count]) → int Inherited
Writes up to count bytes of the buffer from offset buffer offset to the socket. The number of successfully written bytes is returned. This function is non-blocking and will only write data if buffer space is available in the socket.
fold(initialValue, dynamic combine(previous, T element)) → Future Inherited
Reduces a sequence of values by repeatedly applying combine.
firstWhere(bool test(T element), {Object defaultValue()}) → Future Inherited
Finds the first element of this stream matching test.
contains(Object needle) → Future<bool> Inherited
Checks whether needle occurs in the elements provided by this stream.
asyncExpand(Stream convert(T event)) → Stream Inherited
Creates a new stream with the events of a stream per original event.
singleWhere(bool test(T element)) → Future<RawSocketEvent> Inherited
Finds the single element in this stream matching test.
drain([futureValue]) → Future Inherited
Discards all data on the stream, but signals when it's done or an error occured.
close() → Future<RawSocket> Inherited
Closes the socket. Returns a Future that completes with this when the underlying connection is completely destroyed.
asyncMap(dynamic convert(T event)) → Stream Inherited
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
available() → int Inherited
Returns the number of received and non-read bytes in the socket that can be read.
toList() → Future<List<RawSocketEvent>> Inherited
Collects the data of this stream in a List.
asBroadcastStream({void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription)}) → Stream<RawSocketEvent> Inherited
Returns a multi-subscription stream that produces the same events as this.