File sdsio_client.h

FileList > include > sdsio_client.h

Go to the source code of this file

  • #include <stdint.h>

Classes

Type Name
struct header_t

Public Functions

Type Name
int32_t sdsioClientInit (void)
Initialize SDSIO Client and ping SDSIO Server to verify connection.
int32_t sdsioClientReceive (uint8_t * buf, uint32_t buf_size)
Receive data from SDSIO-Server.
int32_t sdsioClientSend (const uint8_t * buf, uint32_t buf_size)
Send data to SDSIO-Server.
int32_t sdsioClientUninit (void)
Un-Initialize SDSIO Client.

Macros

Type Name
define SDSIO_CMD_CLOSE 2U
define SDSIO_CMD_OPEN 1U
define SDSIO_CMD_PING 5U
define SDSIO_CMD_READ 4U
define SDSIO_CMD_WRITE 3U

Public Functions Documentation

function sdsioClientInit

Initialize SDSIO Client and ping SDSIO Server to verify connection.

int32_t sdsioClientInit (
    void
) 

Returns:

SDSIO_OK on success or a negative value on error (see Function Return Codes)


function sdsioClientReceive

Receive data from SDSIO-Server.

int32_t sdsioClientReceive (
    uint8_t * buf,
    uint32_t buf_size
) 

Parameters:

  • buf pointer to buffer for data to read
  • buf_size buffer size in bytes

Returns:

number of bytes successfully received or a negative value on error (see Function Return Codes)


function sdsioClientSend

Send data to SDSIO-Server.

int32_t sdsioClientSend (
    const uint8_t * buf,
    uint32_t buf_size
) 

Parameters:

  • buf pointer to buffer with data to send
  • buf_size buffer size in bytes

Returns:

number of bytes successfully sent or a negative value on error (see Function Return Codes)


function sdsioClientUninit

Un-Initialize SDSIO Client.

int32_t sdsioClientUninit (
    void
) 

Returns:

SDSIO_OK on success or a negative value on error (see Function Return Codes)


Macro Definition Documentation

define SDSIO_CMD_CLOSE

#define SDSIO_CMD_CLOSE `2U`

define SDSIO_CMD_OPEN

#define SDSIO_CMD_OPEN `1U`

define SDSIO_CMD_PING

#define SDSIO_CMD_PING `5U`

define SDSIO_CMD_READ

#define SDSIO_CMD_READ `4U`

define SDSIO_CMD_WRITE

#define SDSIO_CMD_WRITE `3U`


The documentation for this class was generated from the following file sds/include/sdsio_client.h