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
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.
Properties
- InternetAddress address
-
read-only, inheritedReturns the
InternetAddress
used to connect this socket. - Future<RawSocketEvent> first
-
read-only, inheritedReturns the first element of the stream.
- bool isBroadcast
-
read-only, inheritedReports whether this stream is a broadcast stream.
- Future<bool> isEmpty
-
read-only, inheritedReports whether this stream contains any elements.
- Future<RawSocketEvent> last
-
read-only, inheritedReturns the last element of the stream.
- Future<int> length
-
read-only, inheritedCounts the elements in the stream.
- X509Certificate peerCertificate
-
read-onlyGet 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. - int port
-
read-only, inheritedReturns the port used by this socket.
- bool readEventsEnabled
-
read / write, inheritedSet or get, if the RawSocket should listen for RawSocketEvent.READ events. Default is
true
. / - InternetAddress remoteAddress
-
read-only, inheritedReturns the remote
InternetAddress
connected to by this socket. - int remotePort
-
read-only, inheritedReturns the remote port connected to by this socket.
- String selectedProtocol
-
read-onlyGet the protocol which was selected during protocol negotiation.
- Future<RawSocketEvent> single
-
read-only, inheritedReturns the single element.
- bool writeEventsEnabled
-
read / write, inheritedSet 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. /
Constructors
Methods
-
any(
bool test(T element)) → Future<bool> -
inheritedChecks whether
test
accepts any element provided by this stream. -
asBroadcastStream(
{void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription)}) → Stream<RawSocketEvent> -
inheritedReturns a multi-subscription stream that produces the same events as this.
-
asyncExpand(
Stream convert(T event)) → Stream -
inheritedCreates a new stream with the events of a stream per original event.
-
asyncMap(
dynamic convert(T event)) → Stream -
inheritedCreates a new stream with each data event of this stream asynchronously mapped to a new event.
-
available(
) → int -
inheritedReturns the number of received and non-read bytes in the socket that can be read.
-
close(
) → Future<RawSocket> -
inheritedCloses the socket. Returns a Future that completes with
this
when the underlying connection is completely destroyed. -
contains(
Object needle) → Future<bool> -
inheritedChecks whether
needle
occurs in the elements provided by this stream. -
distinct(
[bool equals(T previous, T next)]) → Stream<RawSocketEvent> -
inheritedSkips data events if they are equal to the previous data event.
-
drain(
[futureValue]) → Future -
inheritedDiscards all data on the stream, but signals when it's done or an error occured.
-
elementAt(
int index) → Future<RawSocketEvent> -
inheritedReturns the value of the
index
th data event of this stream. -
every(
bool test(T element)) → Future<bool> -
inheritedChecks whether
test
accepts all elements provided by this stream. -
expand(
Iterable convert(T value)) → Stream -
inheritedCreates a new stream from this stream that converts each element into zero or more events.
-
firstWhere(
bool test(T element), {Object defaultValue()}) → Future -
inheritedFinds the first element of this stream matching
test
. -
fold(
initialValue, dynamic combine(previous, T element)) → Future -
inheritedReduces a sequence of values by repeatedly applying
combine
. -
forEach(
void action(T element)) → Future -
inheritedExecutes
action
on each data event of the stream. -
handleError(
Function onError, {bool test(error)}) → Stream<RawSocketEvent> -
inheritedCreates a wrapper Stream that intercepts some errors from this stream.
-
join(
[String separator = ""]) → Future<String> -
inheritedCollects string of data events' string representations.
-
lastWhere(
bool test(T element), {Object defaultValue()}) → Future -
inheritedFinds the last element in this stream matching
test
. -
listen(
void onData(T event), {Function onError, void onDone(), bool cancelOnError}) → StreamSubscription<RawSocketEvent> -
inheritedAdds a subscription to this stream.
-
map(
dynamic convert(T event)) → Stream -
inheritedCreates a new stream that converts each element of this stream to a new value using the
convert
function. -
pipe(
StreamConsumer<RawSocketEvent> streamConsumer) → Future -
inheritedPipe the events of this stream into
streamConsumer
. -
read(
[int len]) → List<int> -
inheritedRead 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 thenlen
if fewer bytes are available for immediate reading. If no data is availablenull
is returned. -
reduce(
T combine(T previous, T element)) → Future<RawSocketEvent> -
inheritedReduces a sequence of values by repeatedly applying
combine
. -
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.
-
setOption(
SocketOption option, bool enabled) → bool -
inheritedUse setOption to customize the RawSocket. See SocketOption for available options.
-
shutdown(
SocketDirection direction) → void -
inheritedShutdown 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. -
singleWhere(
bool test(T element)) → Future<RawSocketEvent> -
inheritedFinds the single element in this stream matching
test
. -
skip(
int count) → Stream<RawSocketEvent> -
inheritedSkips the first
count
data events from this stream. -
skipWhile(
bool test(T element)) → Stream<RawSocketEvent> -
inheritedSkip data events from this stream while they are matched by
test
. -
take(
int count) → Stream<RawSocketEvent> -
inheritedProvides at most the first
n
values of this stream. -
takeWhile(
bool test(T element)) → Stream<RawSocketEvent> -
inheritedForwards data events while
test
is successful. -
timeout(
Duration timeLimit, {void onTimeout(EventSink sink)}) → Stream -
inheritedCreates a new stream with the same events as this stream.
-
toList(
) → Future<List<RawSocketEvent>> -
inheritedCollects the data of this stream in a List.
-
toSet(
) → Future<Set<RawSocketEvent>> -
inheritedCollects the data of this stream in a Set.
-
transform(
StreamTransformer<RawSocketEvent> streamTransformer) → Stream -
inheritedChains this stream as the input of the provided StreamTransformer.
-
where(
bool test(T event)) → Stream<RawSocketEvent> -
inheritedCreates a new stream from this stream that discards some data events.
-
write(
List<int> buffer, [int offset, int count]) → int -
inheritedWrites up to
count
bytes of the buffer fromoffset
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.