Browse Source

* f2b_csocket_*() : update docs

master
Alex 'AdUser' Z 4 years ago
parent
commit
a61bf8db90
  1. 14
      src/csocket.h

14
src/csocket.h

@ -17,15 +17,15 @@ typedef struct f2b_csock_t f2b_csock_t;
*/ */
/** /**
* @brief Create UNIX socket with given path * @brief Create control socket
* @param path Path to socket endpoint * @param spec String with socket path/address specification
* @returns Socket fd * @returns Allocated socket struct
*/ */
f2b_csock_t * f2b_csocket_create (const char *path); f2b_csock_t * f2b_csocket_create (const char *spec);
/** /**
* @brief Close UNIX socket and unlink endpoint * @brief Destroy socket struct and free resources
* @param csock Socket fd * @param csock Socket struct
* @param path Path to socket endpoint
*/ */
void f2b_csocket_destroy(f2b_csock_t *csock); void f2b_csocket_destroy(f2b_csock_t *csock);

Loading…
Cancel
Save