WriteTransport.setWriteBufferLimits - multiple declarations

Function WriteTransport.setWriteBufferLimits

Set the high- and low-water limits for write flow control.

These two values control when the protocol's pauseWriting() and resumeWriting() methods are called. If specified, the low-water limit must be less than or equal to the high-water limit.

The defaults are implementation-specific. If only the high-water limit is given, the low-water limit defaults to an implementation-specific value less than or equal to the high-water limit. Setting high to zero forces low to zero as well, and causes pauseWriting() to be called whenever the buffer becomes non-empty. Setting low to zero causes resumeWriting() to be called only once the buffer is empty. Use of zero for either limit is generally sub-optimal as it reduces opportunities for doing I/O and computation concurrently.

Prototype

abstract void setWriteBufferLimits(
  std.typecons.Nullable!(ulong) high = Nullable(0LU, true),
  std.typecons.Nullable!(ulong) low = Nullable(0LU, true)
);

Function WriteTransport.setWriteBufferLimits

Set the high- and low-water limits for write flow control.

These two values control when the protocol's pauseWriting() and resumeWriting() methods are called. If specified, the low-water limit must be less than or equal to the high-water limit.

The defaults are implementation-specific. If only the high-water limit is given, the low-water limit defaults to an implementation-specific value less than or equal to the high-water limit. Setting high to zero forces low to zero as well, and causes pauseWriting() to be called whenever the buffer becomes non-empty. Setting low to zero causes resumeWriting() to be called only once the buffer is empty. Use of zero for either limit is generally sub-optimal as it reduces opportunities for doing I/O and computation concurrently.

Prototype

abstract void setWriteBufferLimits(
  std.typecons.Nullable!(ulong) high = Nullable(0LU, true),
  std.typecons.Nullable!(ulong) low = Nullable(0LU, true)
);

Authors

Dragos Carp

Copyright

© 2015-2016 Dragos Carp

License

Boost Software License - Version 1.0