|
Zen API
|
|
Zen API
|
Represents a TCP server.
Inheritance diagram for kTcpServer:Public Member Functions | |
| kAlloc | kObject_Alloc (kObject object) |
| Gets the memory allocator associated with this object. More... | |
| kStatus | kObject_Clone (kObject *object, kObject source, kAlloc allocator) |
| Constructs a new object by copying an existing object, including any aggregated child elements. More... | |
| kStatus | kObject_Destroy (kObject object) |
| Destroys the object. More... | |
| kStatus | kObject_Dispose (kObject object) |
| Destroys the object and any aggregated child elements. More... | |
| kBool | kObject_Equals (kObject object, kObject other) |
| Determines whether the object is equal to another object. More... | |
| kSize | kObject_HashCode (kObject object) |
| Gets a hash code representing the state of this object. More... | |
| kBool | kObject_Is (kObject object, kType type) |
| Determines whether this object is an instance of the specified type. More... | |
| kBool | kObject_IsShared (kObject object) |
| Reports whether the object is currently shared (reference count greater than one). More... | |
| kStatus | kObject_SetPool (kObject object, kObjectPool pool) |
| Sets the object pool associated with this object. More... | |
| kStatus | kObject_Share (kObject object) |
| Increments the reference count associated with this object. More... | |
| kSize | kObject_Size (kObject object) |
| Estimates the memory consumed by this object, including any aggregated child elements. More... | |
| kType | kObject_Type (kObject object) |
| Returns the type of the object. More... | |
| kStatus | kTcpServer_Accept (kTcpServer server, k64u timeout, kTcpClient *client, kAlloc allocator) |
| Blocks until an incoming connection is established, or the specified timeout interval elapses. More... | |
| kStatus | kTcpServer_Construct (kTcpServer *server, kIpVersion ipVersion, kAlloc allocator) |
| Constructs a kTcpServer object. More... | |
| kStatus | kTcpServer_EnableReuseAddress (kTcpServer server, kBool reuse) |
| Enables or disables reuse of a local end point within a short period of time. More... | |
| kStatus | kTcpServer_Listen (kTcpServer server, kIpAddress address, k32u port, kSize backlog) |
| Places the server into the listening state, to monitor for incoming connection requests. More... | |
| kStatus | kTcpServer_LocalEndPoint (kTcpServer server, kIpEndPoint *endPoint) |
| Returns the local end point for a listening server. More... | |
| kStatus | kTcpServer_SetReadBuffers (kTcpServer server, kSSize socketSize, kSSize clientSize) |
| Sets the size of read buffers for accepted client sockets. More... | |
| kStatus | kTcpServer_SetWriteBuffers (kTcpServer server, kSSize socketSize, kSSize clientSize) |
| Sets the size of write buffers for accepted client sockets. More... | |
| kSocket | kTcpServer_Socket (kTcpServer server) |
| Returns the underlying socket object. More... | |
Gets the memory allocator associated with this object.
Most objects are constructed with an allocator, which is used to allocate the memory required by the object. Objects retain a reference to this allocator to enable further allocations and to free memory when the object is destroyed.
| object | Object. |
Constructs a new object by copying an existing object, including any aggregated child elements.
If the source object is an object collection (e.g. kArrayList<kString>), any aggregated child objects are also cloned. In this case, the kObject_Dispose method can be used to free the cloned collection and its associated elements.
This method will fail if the source object (or an aggregated child element) does not support cloning.
| object | Receives the constructed object. |
| source | Source object. |
| allocator | Memory allocator (or kNULL for default). |
Destroys the object.
The kObject_Destroy method destroys the object itself and any resources that are owned by the object. See Object Destruction for more information.
When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.
| object | Object (or kNULL). |
Destroys the object and any aggregated child elements.
The kObject_Dispose method destroys the object itself, any resources that are owned by the object, and if the object represents a collection of objects, any child objects in the collection. See Object Destruction for more information.
When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.
| object | Object (or kNULL). |
Determines whether the object is equal to another object.
By default, objects are compared by reference; objects are considered equal if the given handles refer to the same object instance. However, some classes override the Equals method to provide a more meaningful comparison (e.g. kString).
| object | Object. |
| other | Object for comparison. |
Gets a hash code representing the state of this object.
By default, objects return a hash code based on the object handle value. However, some classes override the HashCode method to provide a more useful hash (e.g. kString).
| object | Object. |
Determines whether this object is an instance of the specified type.
This function compares the type of this object with the given type. An object is considered to be an instance of a given type if a) the type represents a class and this object inherits from (or instantiates) that class, or b) the type represents an interface and this object implements the interface.
| object | Object. |
| type | Type. |
Reports whether the object is currently shared (reference count greater than one).
Objects are initialized with a reference count of one. The kObject_Share method can be used to increment the reference count. The kObject_Destroy and kObject_Dispose methods decrease the reference count, and when the reference count reaches zero, the object is actually destroyed/disposed.
This method can be used to determine if the reference count of an object is currently greater than one.
This method is thread-safe.
| object | Object. |
|
inherited |
Sets the object pool associated with this object.
Object pools can be used to implement custom lifecycle management. If an object has an assigned pool, then the kObjectPool_Reclaim method will be called just prior to destruction, to provide an opportunity for the object to be reclaimed.
| object | Object. |
| pool | Pool object (or kNULL to clear the pool assignment). |
Increments the reference count associated with this object.
This method is thread-safe.
| object | Object. |
Estimates the memory consumed by this object, including any aggregated child elements.
This method can be optionally overridden by kObject-derived classes to report the amount of memory consumed by an object. The default implementation reports only the size of the class instance (additional allocations performed by the class are excluded).
| object | Object. |
Returns the type of the object.
Each object is an instance of a specific class type. The type handle returned by this function can be used to learn about the class.
| object | Object. |
| kStatus kTcpServer_Accept | ( | kTcpServer | server, |
| k64u | timeout, | ||
| kTcpClient * | client, | ||
| kAlloc | allocator | ||
| ) |
Blocks until an incoming connection is established, or the specified timeout interval elapses.
The returned connection object can be kNULL if the connection was closed by the remote client before being accepted.
| server | A kTcpServer object in the listening state. |
| timeout | The timeout interval. |
| client | Returns a kTcpClient object representing the newly-established connection, or kNULL. |
| allocator | Memory allocator (or kNULL for default). |
| kStatus kTcpServer_Construct | ( | kTcpServer * | server, |
| kIpVersion | ipVersion, | ||
| kAlloc | allocator | ||
| ) |
Constructs a kTcpServer object.
| server | Destination for the constructed object handle. |
| ipVersion | Internet Protocol version. |
| allocator | Memory allocator (or kNULL for default). |
| kStatus kTcpServer_EnableReuseAddress | ( | kTcpServer | server, |
| kBool | reuse | ||
| ) |
Enables or disables reuse of a local end point within a short period of time.
The option is typically used to allow a server to rebind to a local end point while a previous socket with the same local end point is in the TIME_WAIT state. This can be useful when a server must be stopped and started within a brief interval, but there is a small risk that packets with identical source/destination information could be misdirected to the new socket.
| server | kTcpServer object. |
| reuse | kTRUE to enable reuse of IP addresses; kFALSE otherwise. |
| kStatus kTcpServer_Listen | ( | kTcpServer | server, |
| kIpAddress | address, | ||
| k32u | port, | ||
| kSize | backlog | ||
| ) |
Places the server into the listening state, to monitor for incoming connection requests.
The server can be placed in the listening state only once per kTcpServer object. After the server is shut down, the kTcpServer object cannot be used to listen again on another port.
| server | kTcpServer object. |
| address | A local IP address to which the server should bind, or kIpAddress_Any(). |
| port | A local port number to which the server should bind, or kIP_PORT_ANY. |
| backlog | The maximum number of pending connection requests to enqueue. |
| kStatus kTcpServer_LocalEndPoint | ( | kTcpServer | server, |
| kIpEndPoint * | endPoint | ||
| ) |
Returns the local end point for a listening server.
| server | kTcpServer object. |
| endPoint | Local end point. |
| kStatus kTcpServer_SetReadBuffers | ( | kTcpServer | server, |
| kSSize | socketSize, | ||
| kSSize | clientSize | ||
| ) |
Sets the size of read buffers for accepted client sockets.
Socket buffers decouple the sender and receiver, so that the sender does not need to block while waiting for the receiver to receive all bytes. Client buffers improve the efficiency of the client when performing several small read operations.
| server | kTcpServer object. |
| socketSize | Size of the read buffer maintained by the underlying socket (-1 to leave unchanged). |
| clientSize | Size of the read buffer maintained by the client object (-1 to leave unchanged). |
| kStatus kTcpServer_SetWriteBuffers | ( | kTcpServer | server, |
| kSSize | socketSize, | ||
| kSSize | clientSize | ||
| ) |
Sets the size of write buffers for accepted client sockets.
Socket buffers decouple the sender and receiver, so that the sender does not need to block while waiting for the receiver to receive all bytes. Client buffers improve the efficiency of the client when performing several small write operations.
By default, the client buffer size is zero and the socket buffer size is determined by the underlying operating system.
| server | kTcpServer object. |
| socketSize | Size of the write buffer maintained by the underlying socket (-1 to leave unchanged). |
| clientSize | Size of the write buffer maintained by the client object (-1 to leave unchanged). |
| kSocket kTcpServer_Socket | ( | kTcpServer | server | ) |
Returns the underlying socket object.
| server | kTcpServer object. |
