Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kTcpClient Class Reference

Description

Represents a TCP client.

Inheritance diagram for kTcpClient:
Inheritance graph

Public Member Functions

kSize kTcpClient_Available (kTcpClient client)
 Returns the number of bytes currently enqueued and available for reading. More...
 
kStatus kTcpClient_Cancel (kTcpClient client)
 Cancels any pending I/O operations. More...
 
kStatus kTcpClient_Connect (kTcpClient client, kIpAddress address, k32u port, k64u timeout)
 Connects to a remote end point. More...
 
kStatus kTcpClient_Construct (kTcpClient *client, kIpVersion ipVersion, kAlloc allocator)
 Constructs a TCP client object. More...
 
kStatus kTcpClient_LocalEndPoint (kTcpClient client, kIpEndPoint *endPoint)
 Returns the local end point for a connected client. More...
 
kStatus kTcpClient_RemoteEndPoint (kTcpClient client, kIpEndPoint *endPoint)
 Returns the remote end point for a connected client. More...
 
kStatus kTcpClient_SetCancelHandler (kTcpClient client, kCallbackFx function, kPointer receiver)
 Sets a cancel query handler, which can be used to asynchronously terminate read/write operations. More...
 
kStatus kTcpClient_SetReadBuffers (kTcpClient client, kSSize socketSize, kSSize clientSize)
 Sets the size of read buffers. More...
 
kStatus kTcpClient_SetReadTimeout (kTcpClient client, k64u timeout)
 Sets the timeout duration for read operations. More...
 
kStatus kTcpClient_SetWriteBuffers (kTcpClient client, kSSize socketSize, kSSize clientSize)
 Sets the size of write buffers. More...
 
kStatus kTcpClient_SetWriteTimeout (kTcpClient client, k64u timeout)
 Sets the timeout duration for write operations. More...
 
kSocket kTcpClient_Socket (kTcpClient client)
 Returns the underlying kSocket object. More...
 
kStatus kTcpClient_Status (kTcpClient client)
 Reports any internal errors that will prevent success of future communication attempts. More...
 
kStatus kTcpClient_Wait (kTcpClient client, k64u timeout)
 Waits until the client has bytes to read or until the specified timeout period elapses. More...
 
- Public Member Functions inherited from kStream
k64u kStream_BytesRead (kStream stream)
 Reports the number of bytes read from this stream. More...
 
k64u kStream_BytesWritten (kStream stream)
 Reports the number of bytes written to this stream. More...
 
kStatus kStream_ClearStats (kStream stream)
 Clears stream statistics (e.g. More...
 
kStatus kStream_Copy (kStream stream, kStream source, kSize size)
 Copies the specified number of bytes from one stream to another. More...
 
kStatus kStream_CopyEx (kStream stream, kStream source, kSize size, kCallbackFx progress, kPointer context)
 Copies the specified number of bytes from one stream to another, with progress feedback. More...
 
kStatus kStream_Flush (kStream stream)
 Flushes buffered writes to the underlying medium. More...
 
kStatus kStream_Read (kStream stream, void *buffer, kSize size)
 Reads the specified number of bytes from the stream. More...
 
kStatus kStream_ReadSome (kStream stream, void *buffer, kSize minCount, kSize maxCount, kSize *bytesRead)
 Reads up to the specified number of bytes from the stream. More...
 
kStatus kStream_Seek (kStream stream, k64s offset, kSeekOrigin origin)
 Moves the read/write pointer to the specified location, if supported by the underlying stream. More...
 
kStatus kStream_Write (kStream stream, const void *buffer, kSize size)
 Writes the specified number of bytes to the stream. More...
 
- Public Member Functions inherited from kObject
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...
 

Additional Inherited Members


The documentation for this class was generated from the following file: