dart:io
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 trusted certificates set in the SecurityContext object. The default SecurityContext object contains a built-in set of trusted root certificates for well-known certificate authorities.
- Implements
-
Constructors
- RawSecureSocket()
Properties
- peerCertificate → X509Certificate
read-only
- Get the peer certificate for a connected RawSecureSocket. If this RawSecureSocket 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 protocol negotiation. [...]
- address → InternetAddress
read-only, inherited
- Returns the InternetAddress used to connect this socket.
- first → Future<RawSocketEvent>
read-only, inherited
- 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
- Whether this stream contains any elements. [...]
- last → Future<RawSocketEvent>
read-only, inherited
- The last element of this stream. [...]
- length → Future<int>
read-only, inherited
- The number of elements in this stream. [...]
- port → int
read-only, inherited
- Returns the port used by this socket.
- readEventsEnabled ↔ bool
read / write, inherited
- Set or get, if the
RawSocket should listen for RawSocketEvent.read events. Default is true. - 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<RawSocketEvent>
read-only, inherited
- The single element of this stream. [...]
- writeEventsEnabled ↔ bool
read / write, inherited
- 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.
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. [...]
- 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<RawSocketEvent>
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. [...]
- available() → int
inherited
- Returns the number of received and non-read bytes in the socket that can be read.
- cast<R>() → Stream<R>
inherited
- Adapt this stream to be a
Stream<R>. [...] - close() → Future<RawSocket>
inherited
- Closes the socket. Returns a Future that completes with this when the underlying connection is completely destroyed. [...]
- contains(Object needle) → Future<bool>
inherited
- Returns whether
needle occurs in the elements provided by this stream. [...] - distinct([bool equals(T previous, T next) ]) → Stream<RawSocketEvent>
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<RawSocketEvent>
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), { RawSocketEvent orElse() }) → Future<RawSocketEvent>
inherited
- Finds the first element of this stream matching
test. [...] - 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 the stream. [...] - handleError(Function onError, { bool test(dynamic error) }) → Stream<RawSocketEvent>
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), { RawSocketEvent orElse() }) → Future<RawSocketEvent>
inherited
- Finds the last element in this stream matching
test. [...] - listen(void onData(T event), { Function onError, void onDone(), bool cancelOnError }) → StreamSubscription<RawSocketEvent>
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<RawSocketEvent> streamConsumer) → Future
inherited
- Pipes the events of this stream into
streamConsumer. [...] - 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. - reduce(RawSocketEvent combine(T previous, T element)) → Future<RawSocketEvent>
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. [...]
- 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.readClosed event. - singleWhere(bool test(T element), { RawSocketEvent orElse() }) → Future<RawSocketEvent>
inherited
- Finds the single element in this stream matching
test. [...] - skip(int count) → Stream<RawSocketEvent>
inherited
- Skips the first
count data events from this stream. [...] - skipWhile(bool test(T element)) → Stream<RawSocketEvent>
inherited
- Skip data events from this stream while they are matched by
test. [...] - take(int count) → Stream<RawSocketEvent>
inherited
- Provides at most the first
count data events of this stream. [...] - takeWhile(bool test(T element)) → Stream<RawSocketEvent>
inherited
- Forwards data events while
test is successful. [...] - timeout(Duration timeLimit, { void onTimeout(EventSink<T> sink) }) → Stream<RawSocketEvent>
inherited
- Creates a new stream with the same events as this stream. [...]
- toList() → Future<List<RawSocketEvent>>
inherited
- Collects all elements of this stream in a List. [...]
- toSet() → Future<Set<RawSocketEvent>>
inherited
- Collects the data of this stream in a Set. [...]
- toString() → String
inherited
- Returns a string representation of this object.
- transform<S>(StreamTransformer<RawSocketEvent, S> streamTransformer) → Stream<S>
inherited
- Applies a StreamTransformer to the current stream. [...]
- where(bool test(T event)) → Stream<RawSocketEvent>
inherited
- Creates a new stream from this stream that discards some elements. [...]
- 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. [...]
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<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<RawSocketEvent> subscription, dynamic host, SecurityContext context, 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, SecurityContext context, { StreamSubscription<RawSocketEvent> 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. [...] - startConnect(dynamic host, int port, { SecurityContext context, bool onBadCertificate(X509Certificate certificate), List<String> supportedProtocols }) → Future<ConnectionTask<RawSecureSocket>>
- Like connect, but returns a Future that completes with a ConnectionTask that can be cancelled if the RawSecureSocket is no longer needed.