interface IConnection in Tinman.Core.IO.Sockets

Base interface for network connections.

interface

IConnection

extends

IDisposable

Remarks

Network connections provided by IConnection implementations are connection oriented and reliable.

Attributes

EndPoint

Returns the network endpoint address of this connections the remote endpoint.

property	EndPoint { get }
type	IEndPoint
value	[not-null]	The network endpoint address.

LifecycleState

Returns the lifecycle state of this object.

property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	ILifecycleState.LifecycleState

Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	IDisposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
method	Dispose ()
inherited	IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

Receive

Receives a sequence of bytes from this network connection.

method	Receive (ByteBuffer buffer)
type	bool
params	buffer	[not-null]	The byte buffer where to store the received bytes.
returns			true if all requested bytes have been received, false if the socket has been closed (via Dispose).

Remarks:

The number of bytes to receive is the number of Remaining bytes in the given ByteBuffer. The received bytes will be written to the buffer beginning at its current Position.

Exceptions:

• IOException:
  If an unexpected error or timeout occurs (see ErrorCode).

Send

Sends a sequence of bytes over this network connection.

method	Send (ByteBuffer buffer)
type	bool
params	buffer	[not-null]	The byte buffer that holds the bytes to send.
returns			true if the data has been sent successfully, false if the socket has been closed (via Dispose).

Remarks:

The Position and Limit of the given ByteBuffer depict the range of bytes in the buffer that will be sent.

Exceptions:

• IOException:
  If an unexpected error or timeout occurs (see ErrorCode).