poser
A C framework for POsix SERvices
Loading...
Searching...
No Matches
PSC_UnixClientOpts Class Reference

Options for creating a UNIX socket client. More...

#include <poser/core/client.h>

Public Member Functions

PSC_UnixClientOptsPSC_UnixClientOpts_create (const char *sockname)
 PSC_UnixClientOpts constructor.
 
void PSC_UnixClientOpts_readBufSize (PSC_UnixClientOpts *self, size_t sz)
 Set read buffer size.
 
void PSC_UnixClientOpts_destroy (PSC_UnixClientOpts *self)
 PSC_UnixClientOpts destructor.
 

Detailed Description

Options for creating a UNIX socket client.

Member Function Documentation

◆ PSC_UnixClientOpts_create()

PSC_UnixClientOpts * PSC_UnixClientOpts_create ( const char *  sockname)

PSC_UnixClientOpts constructor.

Creates an options object initialized to default values.

Parameters
socknamethe name/path of the local socket to connect to
Returns
a newly created options object

◆ PSC_UnixClientOpts_destroy()

void PSC_UnixClientOpts_destroy ( PSC_UnixClientOpts self)

PSC_UnixClientOpts destructor.

Parameters
selfthe PSC_UnixClientOpts

◆ PSC_UnixClientOpts_readBufSize()

void PSC_UnixClientOpts_readBufSize ( PSC_UnixClientOpts self,
size_t  sz 
)

Set read buffer size.

Sets the size of the buffer used for reading from the connection, in bytes. The default value is 16 kiB.

Parameters
selfthe PSC_UnixClientOpts
szthe size of the read buffer, must be > 0

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