bRAWcap API - User mode types. More...

#include "brawcap_types_shared.h"

Data Structures
union	brawcap_adapter_ipv4_t
	IPv4 address. More...

union	brawcap_adapter_ipv6_t
	IPv6 address. More...

Macros
#define	_BRAWCAP_API_FUNC(returnType) __declspec(dllimport) returnType __cdecl
	Dynamic/automatic function import for loading/including.

#define	BRAWCAP_ADAPTER_MAC_LENGTH 6
	Required number of bytes for describing a MAC address. The defined length does not containing any delimiters, it represents the number of MAC address digits.

#define	BRAWCAP_ADAPTER_NAME_LENGTH 40
	The max supported length for an adapter name.

#define	BRAWCAP_RX_BUFFERS_PER_HANDLE_MAX 2
	Max number of supported packet (receive) buffers per bRAWcap handle.

Typedefs
typedef struct _brawcap_handle	brawcap_handle_t
	A bRAWcap handle.

typedef UINT8	brawcap_adapter_count_t
	Type used for counting the available/supported adapters on a machine.

typedef UINT8	brawcap_adapter_mac_t[BRAWCAP_ADAPTER_MAC_LENGTH]
	Fixed size array describing a MAC address.

typedef char	brawcap_adapter_name_t[BRAWCAP_ADAPTER_NAME_LENGTH]
	Fixed size array containing a adapter name.

typedef UINT64	brawcap_adapter_mtu_t
	Type for handling the adapter maximum transmission unit (MTU).

typedef void(*	brawcap_adapter_notify_callback_t) (const brawcap_adapter_name_t name, const brawcap_adapter_notify_reason_t reason, const UINT32 properties, void *pUser)
	The general callback for adapter change notifications. It will be called each time a available and supported adapter change is detected.

typedef void(*	brawcap_adapter_notify_handle_callback_t) (brawcap_handle_t const pHandle, const brawcap_adapter_notify_reason_t reason, const UINT32 properties, void pUser)
	The per handle callback for adapter change notifications. It will be called each time a change for the handle underlying adapter (and only for this adapter) is detected.

typedef void(*	brawcap_rx_callback_t) (brawcap_handle_t const pHandle, const brawcap_status_t status, brawcap_buffer_t const pBuffer, void *pUser)
	Receive callback which is called each time a receive has finished. Receiving can be started with brawcap_rx_start and has to be stopped with brawcap_rx_stop. Before anything can be received it is necessary to attach packet buffers to the bRAWcap handle. This can be done by creating new bRAWcap buffers (brawcap_buffer_create) and attach it with brawcap_rx_buffer_attach.

typedef void(*	brawcap_tx_callback_t) (brawcap_handle_t const pHandle, const brawcap_status_t status, brawcap_buffer_t const pBuffer, void *pUser)
	Transmit callback which is called each time a transmission initiated with brawcap_tx_buffer_send has finished.

Enumerations
enum	brawcap_log_level_t { BRAWCAP_LOG_LEVEL_DEBUG = 0x01 , BRAWCAP_LOG_LEVEL_VERBOSE = 0x02 , BRAWCAP_LOG_LEVEL_NOTICE = 0x04 , BRAWCAP_LOG_LEVEL_WARNING = 0x08 , BRAWCAP_LOG_LEVEL_ERROR = 0x10 }
	List of bRAWcap log levels. More...

enum	brawcap_log_type_t { BRAWCAP_LOG_TYPE_GENERIC = 0x01 , BRAWCAP_LOG_TYPE_ADAPTER = 0x02 , BRAWCAP_LOG_TYPE_RECEIVE = 0x04 , BRAWCAP_LOG_TYPE_TRANSMIT = 0x08 , BRAWCAP_LOG_TYPE_LICENSE = 0x10 , BRAWCAP_LOG_TYPE_ALL = 0xFFFF }
	List of bRAWcap log types. More...

enum	brawcap_adapter_speed_t { BRAWCAP_ADAPTER_SPEED_UNKNOWN = 0ULL , BRAWCAP_ADAPTER_SPEED_10M = 10ULL , BRAWCAP_ADAPTER_SPEED_100M = 100ULL , BRAWCAP_ADAPTER_SPEED_1G = 1000ULL , BRAWCAP_ADAPTER_SPEED_2_5G = 2500ULL , BRAWCAP_ADAPTER_SPEED_5G = 5000ULL , BRAWCAP_ADAPTER_SPEED_10G = 10000ULL , BRAWCAP_ADAPTER_SPEED_25G = 25000ULL , BRAWCAP_ADAPTER_SPEED_40G = 40000ULL , BRAWCAP_ADAPTER_SPEED_50G = 50000ULL , BRAWCAP_ADAPTER_SPEED_100G = 100000ULL }
	List of bRAWcap adapter speeds. Values indicating the current adapter uplink speed. More...

enum	brawcap_adapter_connection_state_t { BRAWCAP_ADAPTER_CONNECTION_UNKNOWN = 0 , BRAWCAP_ADAPTER_CONNECTION_UP = 1 , BRAWCAP_ADAPTER_CONNECTION_DOWN = 2 }
	List of adapter connection states. Values indicating the current adapter connection state (uplink/cable connected). More...

enum	brawcap_adapter_operation_state_t { BRAWCAP_ADAPTER_OPERATION_UNKNOWN = 0 , BRAWCAP_ADAPTER_OPERATION_UP = 1 , BRAWCAP_ADAPTER_OPERATION_DOWN = 2 , BRAWCAP_ADAPTER_OPERATION_TESTING = 3 }
	List of adapter operation states. Values indicating the current adapter operation state (adapter driver status). More...

enum	brawcap_adapter_notify_reason_t { BRAWCAP_ADAPTER_NOTIFY_REASON_UNKNOWN = 0 , BRAWCAP_ADAPTER_NOTIFY_REASON_ADD = 1 , BRAWCAP_ADAPTER_NOTIFY_REASON_REMOVE = 2 , BRAWCAP_ADAPTER_NOTIFY_REASON_PROPERTY_CHANGE = 3 }
	List of reasons for adapter change notifications. This values indicate why a adapter change notification is received. More...

enum	brawcap_adapter_properties_t { BRAWCAP_ADAPTER_PROPERTY_FRIENDLY_NAME = 0x0001 , BRAWCAP_ADAPTER_PROPERTY_RX_SPEED = 0x0002 , BRAWCAP_ADAPTER_PROPERTY_TX_SPEED = 0x0004 , BRAWCAP_ADAPTER_PROPERTY_MTU = 0x0008 , BRAWCAP_ADAPTER_PROPERTY_OPERATION_STATE = 0x0010 , BRAWCAP_ADAPTER_PROPERTY_CONNECTION_STATE = 0x0020 , BRAWCAP_ADAPTER_PROPERTY_IPV4 = 0x0040 , BRAWCAP_ADAPTER_PROPERTY_IPV6 = 0x0080 }
	List of adapter properties. They are used to identify adapter change notifications with a property change reason. More...

Detailed Description

bRAWcap API - User mode types.

The file includes all (data)types and defines used for bRAWcap (user space only).

All rights exclusively reserved for b-plus GmbH, unless expressly otherwise agreed.

Redistribution in source or any other form, with or without modification, is not permitted.

You may use this code under the according license terms of b-plus. Please contact b-plus at servi.nosp@m.ces@.nosp@m.b-plu.nosp@m.s.co.nosp@m.m to get the appropriate terms and conditions.

Data Structures

Macros

Typedefs

Enumerations

Detailed Description