Group SDS_IO_Interface

Modules > SDS_IO_Interface

sdsio.h : SDS I/O Interface for data streamsMore...

Public Types

Public Functions

Detailed Description

The stream data can be written to an output device or read from an input device. Typically these interfaces communicate to an SDS I/O server that reads or writes SDS data files.

Public Types Documentation

typedef sdsioId_t

Handle to SDS I/O stream.

typedef void* sdsioId_t;

todo test

---

enum sdsioMode_t

Open Mode.

enum sdsioMode_t {
    sdsioModeRead = 0,
    sdsioModeWrite = 1
};

todo

---

Public Functions Documentation

function sdsioClose

Close I/O stream.

int32_t sdsioClose (
    sdsioId_t id
) 

todo

Parameters:

• id sdsioId_t handle to SDS I/O stream

Returns:

return code

---

function sdsioEndOfStream

Check if end of stream has been reached.

int32_t sdsioEndOfStream (
    sdsioId_t id
) 

todo

Parameters:

• id sdsioId_t handle to SDS I/O stream

Returns:

nonzero if end of stream, else 0

---

function sdsioInit

Initialize SDS I/O.

int32_t sdsioInit (
    void
) 

todo

Returns:

return code

---

function sdsioOpen

Open I/O stream.

sdsioId_t sdsioOpen (
    const char * name,
    sdsioMode_t mode
) 

todo

Parameters:

• name stream name (pointer to NULL terminated string)
• mode sdsioMode_t open mode

Returns:

sdsioId_t

---

function sdsioRead

Read data from I/O stream.

uint32_t sdsioRead (
    sdsioId_t id,
    void * buf,
    uint32_t buf_size
) 

todo

Parameters:

• id sdsioId_t handle to SDS I/O stream
• buf pointer to buffer for data to read
• buf_size buffer size in bytes

Returns:

number of bytes read

---

function sdsioUninit

Un-initialize SDS I/O.

int32_t sdsioUninit (
    void
) 

todo

Returns:

return code

---

function sdsioWrite

Write data to I/O stream.

uint32_t sdsioWrite (
    sdsioId_t id,
    const void * buf,
    uint32_t buf_size
) 

todo

Parameters:

• id sdsioId_t handle to SDS I/O stream
• buf pointer to buffer with data to write
• buf_size buffer size in bytes

Returns:

number of bytes written

---

---