caiyu/gmio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

gmio_core: more doc

Browse Source
This commit is contained in:
Hugues Delorme 2015-09-19 23:15:06 +02:00
parent f6e5f8937b
commit 215fd68c2b
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/gmio_core/stream.h
View File

@ -95,7 +95,19 @@ struct gmio_stream
/*! Pointer on a function that returns the size(in bytes) of the stream */
size_t (*func_size)(void* cookie);
/*! Pointer on a function that retrieves the current position in the stream
*
* \retval 0 on success
* \retval !=0 on error
*/
int (*func_get_pos)(void* cookie, gmio_stream_pos_t* pos);
/*! Pointer on a function that restores the current position in the stream
* to \p pos
*
* \retval 0 on success
* \retval !=0 on error
*/
int (*func_set_pos)(void* cookie, const gmio_stream_pos_t* pos);
};

11
src/gmio_core/stream_pos.h
View File

@ -25,19 +25,28 @@
#include "global.h"
/*! Size of the byte array gmio_stream_pos::cookie */
enum { GMIO_STREAM_POS_COOKIE_SIZE = 32 }; /* 32 bytes */
/*! Stream position
/*! Specifies a position within a stream
*
* The information in gmio_stream_pos objects is usually filled by a call to
* gmio_stream::func_get_pos(), which takes a pointer to an object of this type
* as argument.
*
* The content of a gmio_stream_pos object is not meant to be read directly,
* but only to be used as an argument in a call to gmio_stream::func_set_pos()
*/
struct gmio_stream_pos
{
/*! Stores the actual(concrete) stream position object */
uint8_t cookie[GMIO_STREAM_POS_COOKIE_SIZE];
};
typedef struct gmio_stream_pos gmio_stream_pos_t;
GMIO_C_LINKAGE_BEGIN
/*! Returns a null stream position */
GMIO_LIB_EXPORT gmio_stream_pos_t gmio_stream_pos_null();
GMIO_C_LINKAGE_END