Interface TcpConnection

Represents a single TCP connection.

Inherits from

Properties

Property name Type Description
tcpNoDelay bool Used to disable Nagle's algorithm
readTimeout Duration Controls the read time out after which the connection is closed automatically
connected bool The current connection status
peerAddress string Returns the IP address of the connected peer.
empty [inherited] bool Returns true iff the end of the stream has been reached
leastSize [inherited] ulong Returns the maximum number of bytes that are known to remain in this stream until the end is reached. After leastSize() bytes have been read, the stream will either have reached EOS and empty() returns true, or leastSize() returns again a number > 0.
dataAvailableForRead [inherited] bool Queries if there is data available for immediate, non-blocking read.

Methods

Method name Description
close Actively closes the connection.
waitForData Sets a timeout until data has to be availabe for read. Returns false on timeout.
peek [inherited] Returns a temporary reference to the data that is currently buffered, typically has the size leastSize() or 0 if dataAvailableForRead() returns false.
read [inherited] Fills the preallocated array 'bytes' with data from the stream.
write [inherited] Writes an array of bytes to the stream.
flush [inherited] Flushes the stream and makes sure that all data is being written to the output device.
finalize [inherited] Flushes and finalizes the stream.
write [inherited] Writes an array of chars to the stream.
write [inherited] Pipes an InputStream directly into this OutputStream.
put [inherited] These methods provide an output range interface.
release [inherited] Releases the ownership of the object.
acquire [inherited] Acquires the ownership of an unowned object.
isOwner [inherited] Returns true if the calling fiber owns this object

Authors

Sönke Ludwig

Copyright

© 2012 RejectedSoftware e.K.

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.