Interface TCPConnection

Represents a single TCP connection.

Inherits from

Properties

Name Type Description
connected bool Determines The current connection status.
peerAddress string Returns the IP address of the connected peer.
readTimeout Duration Controls the read time out after which the connection is closed automatically.
tcpNoDelay bool Used to disable Nagle's algorithm.
dataAvailableForRead bool Queries if there is data available for immediate, non-blocking read.
empty bool Returns true iff the end of the stream has been reached
leastSize 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.

Methods

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

Aliases

Name Description
isOwner Compatibility alias, will be deprecated soon.

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.