BALTECH SDK wrapper functions reference
ioiter.h
Go to the documentation of this file.
1 
13 #ifndef __IOITER_H__
14 #define __IOITER_H__
15 
16 #include "common.h"
17 #include "protocol.h"
18 
25 struct brp_ioiter_t
26 {
27  brp_errcode (*next_fn)(struct brp_ioiter_t* iter, brp_protocol* protocol);
28  void (*destroy_fn)(struct brp_ioiter_t* iter);
29 };
30 
34 typedef struct brp_ioiter_t * brp_ioiter;
35 
36 
73 BRP_LIB brp_ioiter brp_ioiter_create(void);
74 
75 
94 BRP_LIB brp_errcode brp_ioiter_next(brp_ioiter iter, brp_protocol* protocol);
95 
96 
106 BRP_LIB void brp_ioiter_destroy(brp_ioiter* iter);
107 
108 
109 #endif
110  // end of defgroup brp_ioiter
brp_errcode
unsigned int brp_errcode
This type is used library-wide for passing error codes in the return value of functions.
Definition: errorcodes.h:23
brp_ioiter_next
BRP_LIB brp_errcode brp_ioiter_next(brp_ioiter iter, brp_protocol *protocol)
Retrieves the next device from the iterator.
brp_ioiter_t::destroy_fn
void(* destroy_fn)(struct brp_ioiter_t *iter)
Definition: ioiter.h:28
brp_protocol
struct brp_protocol_t * brp_protocol
This is a generic handle of a protocol.
Definition: protocol.h:34
brp_ioiter_destroy
BRP_LIB void brp_ioiter_destroy(brp_ioiter *iter)
Destroys an iterator and frees all associated resources.
protocol.h
This file primarly defines the common part of all protocol's data structures (:brp_protocol_t) and AP...
brp_ioiter_t::next_fn
brp_errcode(* next_fn)(struct brp_ioiter_t *iter, brp_protocol *protocol)
Definition: ioiter.h:27
brp_ioiter
struct brp_ioiter_t * brp_ioiter
Handle to an I/O device iterator.
Definition: ioiter.h:34
brp_ioiter_create
BRP_LIB brp_ioiter brp_ioiter_create(void)
Creates an iterator for enumerating all available I/O devices.
common.h
Contains the basic defines that are required throughout the BRP library.
brp_ioiter_t
Base structure for I/O device iterators.
Definition: ioiter.h:25