mirror of
https://github.com/dart-lang/sdk
synced 2024-10-14 12:30:03 +00:00
[io/doc]: Provide more references to SocketOption.tcpNoDelay.
Bug: https://github.com/dart-lang/sdk/issues/52102 Change-Id: I759735acfb0a67a3c0e359d6cf4c0ecab97c6c2a CoreLibraryReviewExempt: doc-only change Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/325443 Reviewed-by: Alexander Aprelev <aam@google.com> Commit-Queue: Brian Quinlan <bquinlan@google.com>
This commit is contained in:
parent
252bfcb27a
commit
f0632629c3
|
@ -6,7 +6,7 @@ part of dart.io;
|
|||
|
||||
/// A TCP socket using TLS and SSL.
|
||||
///
|
||||
/// A secure socket may be used as either a [Stream] or an [IOSink].
|
||||
/// See [Socket] for more information.
|
||||
abstract interface class SecureSocket implements Socket {
|
||||
external factory SecureSocket._(RawSecureSocket rawSocket);
|
||||
|
||||
|
@ -227,6 +227,8 @@ abstract interface class SecureSocket implements Socket {
|
|||
/// 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.
|
||||
///
|
||||
/// See [RawSocket] for more information.
|
||||
abstract interface class RawSecureSocket implements RawSocket {
|
||||
/// Constructs a new secure client socket and connect it to the given
|
||||
/// host on the given port.
|
||||
|
|
|
@ -205,7 +205,7 @@ abstract interface class NetworkInterface {
|
|||
/// A `RawServerSocket` and provides a stream of low-level [RawSocket] objects,
|
||||
/// one for each connection made to the listening socket.
|
||||
///
|
||||
/// See [RawSocket] for more info.
|
||||
/// See [RawSocket] for more information.
|
||||
abstract interface class RawServerSocket implements Stream<RawSocket> {
|
||||
/// Listens on a given address and port.
|
||||
///
|
||||
|
@ -610,9 +610,13 @@ abstract interface class RawSocket implements Stream<RawSocketEvent> {
|
|||
/// 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.
|
||||
/// 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. This means that the number of successfully written bytes may
|
||||
/// be less than `count` or even 0.
|
||||
///
|
||||
/// Transmission of the buffer may be delayed unless
|
||||
/// [SocketOption.tcpNoDelay] is set with [RawSocket.setOption].
|
||||
///
|
||||
/// The default value for [offset] is 0, and the default value for [count] is
|
||||
/// `buffer.length - offset`.
|
||||
|
@ -719,6 +723,10 @@ abstract interface class RawSocket implements Stream<RawSocketEvent> {
|
|||
/// Data, as [Uint8List]s, is received by the local socket, made available
|
||||
/// by the [Stream] interface of this class, and can be sent to the remote
|
||||
/// socket through the [IOSink] interface of this class.
|
||||
///
|
||||
/// Transmission of the data sent through the [IOSink] interface may be
|
||||
/// delayed unless [SocketOption.tcpNoDelay] is set with
|
||||
/// [Socket.setOption].
|
||||
abstract interface class Socket implements Stream<Uint8List>, IOSink {
|
||||
/// Creates a new socket connection to the host and port and returns a [Future]
|
||||
/// that will complete with either a [Socket] once connected or an error
|
||||
|
|
Loading…
Reference in a new issue