Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Modules | Data Structures | Macros | Typedefs

Modules

 afw_stream
 

Data Structures

struct  afw_stream_s
 Interface afw_stream public struct. More...
 
struct  afw_stream_inf_s
 Interface afw_stream_inf_s struct. More...
 

Macros

#define AFW_STREAM_INTERFACE_NAME   "afw_stream"
 define for interface afw_stream name.
 
#define afw_stream_release(instance, xctx)
 Call method release of interface afw_stream. More...
 
#define afw_stream_flush(instance, xctx)
 Call method flush of interface afw_stream. More...
 
#define afw_stream_read(instance, buffer, size, xctx)
 Call method read of interface afw_stream. More...
 
#define afw_stream_write(instance, buffer, size, xctx)
 Call method write of interface afw_stream. More...
 

Typedefs

typedef void(* afw_stream_release_t) (const afw_stream_t *instance, afw_xctx_t *xctx)
 
typedef void(* afw_stream_flush_t) (const afw_stream_t *instance, afw_xctx_t *xctx)
 
typedef void(* afw_stream_read_t) (const afw_stream_t *instance, const void *buffer, afw_size_t size, afw_xctx_t *xctx)
 
typedef void(* afw_stream_write_t) (const afw_stream_t *instance, const void *buffer, afw_size_t size, afw_xctx_t *xctx)
 

Detailed Description

An interface for a stream.

Macro Definition Documentation

◆ afw_stream_flush

#define afw_stream_flush (   instance,
  xctx 
)
Value:
(instance)->inf->flush( \
(instance), \
(xctx) \
)

Call method flush of interface afw_stream.

Parameters
instancePointer to this stream instance.
xctxThis is the caller's xctx.

Definition at line 4476 of file afw_interface.h.

◆ afw_stream_read

#define afw_stream_read (   instance,
  buffer,
  size,
  xctx 
)
Value:
(instance)->inf->read( \
(instance), \
(buffer), \
(size), \
(xctx) \
)

Call method read of interface afw_stream.

Parameters
instancePointer to this stream instance.
bufferBuffer to write.
sizeSize of buffer.
xctxThis is the caller's xctx.

Definition at line 4492 of file afw_interface.h.

◆ afw_stream_release

#define afw_stream_release (   instance,
  xctx 
)
Value:
(instance)->inf->release( \
(instance), \
(xctx) \
)

Call method release of interface afw_stream.

Parameters
instancePointer to this stream instance.
xctxThis is the caller's xctx.

Definition at line 4462 of file afw_interface.h.

◆ afw_stream_write

#define afw_stream_write (   instance,
  buffer,
  size,
  xctx 
)
Value:
(instance)->inf->write( \
(instance), \
(buffer), \
(size), \
(xctx) \
)

Call method write of interface afw_stream.

Parameters
instancePointer to this stream instance.
bufferBuffer to write.
sizeSize of buffer.
xctxThis is the caller's xctx.

Definition at line 4512 of file afw_interface.h.

Typedef Documentation

◆ afw_stream_flush_t

typedef void(* afw_stream_flush_t) (const afw_stream_t *instance, afw_xctx_t *xctx)
See also
afw_stream_flush()

Definition at line 4427 of file afw_interface.h.

◆ afw_stream_read_t

typedef void(* afw_stream_read_t) (const afw_stream_t *instance, const void *buffer, afw_size_t size, afw_xctx_t *xctx)
See also
afw_stream_read()

Definition at line 4433 of file afw_interface.h.

◆ afw_stream_release_t

typedef void(* afw_stream_release_t) (const afw_stream_t *instance, afw_xctx_t *xctx)
See also
afw_stream_release()

Definition at line 4421 of file afw_interface.h.

◆ afw_stream_write_t

typedef void(* afw_stream_write_t) (const afw_stream_t *instance, const void *buffer, afw_size_t size, afw_xctx_t *xctx)
See also
afw_stream_write()

Definition at line 4441 of file afw_interface.h.