TizenRT Libs&Environment  v2.0 M2

Provides APIs for Streams. More...

Collaboration diagram for STREAMS:

Data Structures

struct  lib_instream_s
 Structure for getting character from the instream. More...
 
struct  lib_outstream_s
 Structure for putting character to the outstream. More...
 
struct  lib_sistream_s
 Structure for getting character from the instream with seek operation support. More...
 
struct  lib_sostream_s
 Structure for putting character to the outstream with seek operation support. More...
 
struct  lib_meminstream_s
 Structure for operation on a fixed-sized block of memory with lib_instream_s. More...
 
struct  lib_memoutstream_s
 Structure for operation on a fixed-sized block of memory with lib_outstream_s. More...
 
struct  lib_memsistream_s
 Structure for operation on a fixed-sized block of memory with lib_sistream_s. More...
 
struct  lib_memsostream_s
 Structure for operation on a fixed-sized block of memory with lib_sostream_s. More...
 
struct  lib_stdinstream_s
 Structure for operation on a FILE with lib_instream_s. More...
 
struct  lib_stdoutstream_s
 Structure for operation on a FILE with lib_outstream_s. More...
 
struct  lib_stdsistream_s
 Structure for operation on a FILE with lib_sistream_s. More...
 
struct  lib_stdsostream_s
 Structure for operation on a FILE with lib_sostream_s. More...
 
struct  lib_rawinstream_s
 Structure for operation on a fd with lib_instream_s. More...
 
struct  lib_rawoutstream_s
 Structure for operation on a fd with lib_outstream_s. More...
 
struct  lib_rawsistream_s
 Structure for operation on a fd with lib_sistream_s. More...
 
struct  lib_rawsostream_s
 Structure for operation on a fd with lib_sostream_s. More...
 

Functions

void lib_meminstream (FAR struct lib_meminstream_s *instream, FAR const char *bufstart, int buflen)
 Initializes a stream for use with a fixed-size memory buffer. More...
 
void lib_memoutstream (FAR struct lib_memoutstream_s *outstream, FAR char *bufstart, int buflen)
 Initializes a stream for use with a fixed-size memory buffer. More...
 
void lib_memsistream (FAR struct lib_memsistream_s *instream, FAR const char *bufstart, int buflen)
 Initializes a stream for use with a fixed-size memory buffer. More...
 
void lib_memsostream (FAR struct lib_memsostream_s *outstream, FAR char *bufstart, int buflen)
 Initializes a stream for use with a fixed-size memory buffer. More...
 
void lib_stdinstream (FAR struct lib_stdinstream_s *instream, FAR FILE *stream)
 Initializes a stream for use with a FILE instance. More...
 
void lib_stdoutstream (FAR struct lib_stdoutstream_s *outstream, FAR FILE *stream)
 Initializes a stream for use with a FILE instance. More...
 
void lib_stdsistream (FAR struct lib_stdsistream_s *instream, FAR FILE *stream)
 Initializes a stream for use with a FILE instance. More...
 
void lib_stdsostream (FAR struct lib_stdsostream_s *outstream, FAR FILE *stream)
 Initializes a stream for use with a FILE instance. More...
 
void lib_rawinstream (FAR struct lib_rawinstream_s *instream, int fd)
 Initializes a stream for use with a file descriptor. More...
 
void lib_rawoutstream (FAR struct lib_rawoutstream_s *outstream, int fd)
 Initializes a stream for use with a file descriptor. More...
 
void lib_rawsistream (FAR struct lib_rawsistream_s *instream, int fd)
 Initializes a stream for use with a file descriptor. More...
 
void lib_rawsostream (FAR struct lib_rawsostream_s *outstream, int fd)
 Initializes a stream for use with a file descriptor. More...
 
void lib_lowoutstream (FAR struct lib_outstream_s *lowoutstream)
 Initializes a stream for use with low-level, architecture-specific I/O. More...
 
void lib_zeroinstream (FAR struct lib_instream_s *zeroinstream)
 Initializes NULL stream. More...
 
void lib_nullinstream (FAR struct lib_instream_s *nullinstream)
 Initializes NULL stream. More...
 
void lib_nulloutstream (FAR struct lib_outstream_s *nulloutstream)
 Initializes NULL stream. More...
 

Detailed Description

Provides APIs for Streams.

Function Documentation

void lib_lowoutstream ( FAR struct lib_outstream_s lowoutstream)

Initializes a stream for use with low-level, architecture-specific I/O.

#include <tinyara/streams.h>

Parameters
[in]lowoutstreamUser allocated, uninitialized instance of struct lib_lowoutstream_s
Returns
None
Since
TizenRT v1.1
void lib_meminstream ( FAR struct lib_meminstream_s instream,
FAR const char *  bufstart,
int  buflen 
)

Initializes a stream for use with a fixed-size memory buffer.

#include <tinyara/streams.h>

Parameters
[in]instreamUser allocated, uninitialized instance of struct lib_meminstream_s
[in]bufstartAddress of the beginning of the fixed-size memory buffer
[in]buflenSize of the fixed-sized memory buffer in bytes
Returns
None
Since
TizenRT v1.1
void lib_memoutstream ( FAR struct lib_memoutstream_s outstream,
FAR char *  bufstart,
int  buflen 
)

Initializes a stream for use with a fixed-size memory buffer.

#include <tinyara/streams.h>

Parameters
[in]outstreamUser allocated, uninitialized instance of struct lib_memoutstream_s
[in]bufstartAddress of the beginning of the fixed-size memory buffer
[in]buflenSize of the fixed-sized memory buffer in bytes
Returns
None
Since
TizenRT v1.1
void lib_memsistream ( FAR struct lib_memsistream_s instream,
FAR const char *  bufstart,
int  buflen 
)

Initializes a stream for use with a fixed-size memory buffer.

#include <tinyara/streams.h>

Parameters
[in]instreamUser allocated, uninitialized instance of struct lib_memsistream_s
[in]bufstartAddress of the beginning of the fixed-size memory buffer
[in]buflenSize of the fixed-sized memory buffer in bytes
Returns
None
Since
TizenRT v1.1
void lib_memsostream ( FAR struct lib_memsostream_s outstream,
FAR char *  bufstart,
int  buflen 
)

Initializes a stream for use with a fixed-size memory buffer.

#include <tinyara/streams.h>

Parameters
[in]outstreamUser allocated, uninitialized instance of struct lib_memsostream_s
[in]bufstartAddress of the beginning of the fixed-size memory buffer
[in]buflenSize of the fixed-sized memory buffer in bytes
Returns
None
Since
TizenRT v1.1
void lib_nullinstream ( FAR struct lib_instream_s nullinstream)

Initializes NULL stream.

#include <tinyara/streams.h>

Parameters
[in]nullinstreamUser allocated, uninitialized instance of struct lib_instream_s
Returns
None
Since
TizenRT v1.1
void lib_nulloutstream ( FAR struct lib_outstream_s nulloutstream)

Initializes NULL stream.

#include <tinyara/streams.h>

Parameters
[in]nulloutstreamUser allocated, uninitialized instance of struct lib_outstream_s
Returns
None
Since
TizenRT v1.1
void lib_rawinstream ( FAR struct lib_rawinstream_s instream,
int  fd 
)

Initializes a stream for use with a file descriptor.

#include <tinyara/streams.h>

Parameters
[in]instreamUser allocated, uninitialized instance of struct lib_rawinstream_s
[in]fdfile/socket descriptor provided by user
Returns
None
Since
TizenRT v1.1
void lib_rawoutstream ( FAR struct lib_rawoutstream_s outstream,
int  fd 
)

Initializes a stream for use with a file descriptor.

#include <tinyara/streams.h>

Parameters
[in]outstreamUser allocated, uninitialized instance of struct lib_rawoutstream_s
[in]fdfile/socket descriptor provided by user
Returns
None
Since
TizenRT v1.1
void lib_rawsistream ( FAR struct lib_rawsistream_s instream,
int  fd 
)

Initializes a stream for use with a file descriptor.

#include <tinyara/streams.h>

Parameters
[in]instreamUser allocated, uninitialized instance of struct lib_rawsistream_s
[in]fdfile/socket descriptor provided by user
Returns
None
Since
TizenRT v1.1
void lib_rawsostream ( FAR struct lib_rawsostream_s outstream,
int  fd 
)

Initializes a stream for use with a file descriptor.

#include <tinyara/streams.h>

Parameters
[in]outstreamUser allocated, uninitialized instance of struct lib_rawsostream_s
[in]fdfile/socket descriptor provided by user
Returns
None
Since
TizenRT v1.1
void lib_stdinstream ( FAR struct lib_stdinstream_s instream,
FAR FILE stream 
)

Initializes a stream for use with a FILE instance.

#include <tinyara/streams.h>

Parameters
[in]instreamUser allocated, uninitialized instance of struct lib_stdinstream_s
[in]streamStream provided by user
Returns
None
Since
TizenRT v1.1
void lib_stdoutstream ( FAR struct lib_stdoutstream_s outstream,
FAR FILE stream 
)

Initializes a stream for use with a FILE instance.

#include <tinyara/streams.h>

Parameters
[in]outstreamUser allocated, uninitialized instance of struct lib_stdoutstream_s
[in]streamStream provided by user
Returns
None
Since
TizenRT v1.1
void lib_stdsistream ( FAR struct lib_stdsistream_s instream,
FAR FILE stream 
)

Initializes a stream for use with a FILE instance.

#include <tinyara/streams.h>

Parameters
[in]instreamUser allocated, uninitialized instance of struct lib_stdsistream_s
[in]streamStream provided by user
Returns
None
Since
TizenRT v1.1
void lib_stdsostream ( FAR struct lib_stdsostream_s outstream,
FAR FILE stream 
)

Initializes a stream for use with a FILE instance.

#include <tinyara/streams.h>

Parameters
[in]outstreamUser allocated, uninitialized instance of struct lib_stdsostream_s
[in]streamStream provided by user
Returns
None
Since
TizenRT v1.1
void lib_zeroinstream ( FAR struct lib_instream_s zeroinstream)

Initializes NULL stream.

#include <tinyara/streams.h>

Parameters
[in]zeroinstreamUser allocated, uninitialized instance of struct lib_instream_s
Returns
None
Since
TizenRT v1.1