utils.h File Reference

NetBurner Utilities API. More...

#include <predef.h>
#include <stddef.h>
#include "nettypes.h"
#include <ipv6/ipv6_addr.h>

Go to the source code of this file.

Macros
#define	DB_TCPIP   (1)
	Debug output control flags for NetBurner system components.
#define	DB_HTTP   (2)
	HTTP debug messages.
#define	DB_ETHER   (4)
	Ethernet debug messages.
#define	DB_RTOS   (8)
	RTOS debug messages.
#define	DB_BUFFER   (16)
	Buffer debug messages.
#define	DB_PPP   (32)
	PPP debug messages.
#define	DB_AU   (64)
	Authentication debug messages.
#define	DB_MAIL   (128)
	Mail debug messages.
#define	DB_IP   (256)
	IP debug messages.
#define	DB_TCPDATA   (512)
	TCP data debug messages.
#define	DB_SSL   (1024)
	SSL debug messages.
#define	DB_SNMP   (2048)
	SNMP debug messages.
#define	DB_IPV6_ND   (4096)
	IPv6 Neighbor Discovery debug messages.
#define	DB_IPV6_ICMP   (8192)
	IPv6 ICMP debug messages.
#define	DB_IPV6_ROUTE   (16384)
	IPv6 routing debug messages.
#define	DB_IPV6_FRAG   (32768)
	IPv6 fragmentation debug messages.
#define	DB_IPV6_ERR   (65536)
	IPv6 error debug messages.

Functions
IPADDR	AsciiToIp6 (const char *p)
	Convert an ASCII IPv6 string to an IP address.
void	ShowCounters ()
	Dump all system counters to stdio.
void	sShowCounters (char *buffer, int slen)
	Dump all system counters to a memory buffer.
void	FdShowRingData (int fd, const uint8_t *ringBuf, uint32_t bufLen, uint32_t start, uint32_t end, const char *indent=NULL)
	Dump part of a ring buffer to file descriptor.
void	ShowRingData (const uint8_t *ringBuf, uint32_t bufLen, uint32_t start, uint32_t end, const char *indent=NULL)
	Dump part of a ring buffer to stdio.
void	FdShowData (int fd, const uint8_t *fromptr, uint16_t len)
	Dump a block of data to file descriptor and show in ASCII and hex.
void	ShowData (const uint8_t *fromptr, uint16_t len)
	Dump a block of data to stdio and show in ASCII and hex.
void	ShowMac (const MACADR *ma)
	Dump a MAC address to stdio.
void	fdShowMac (int fd, const MACADR *ma)
	Dump a MAC address to file descriptor.
void	ShowMac (const MACADR &ma)
	Dump a MAC address to stdio (reference version)
void	snShowMac (char *buf, size_t maxlen, const MACADR *ma)
	Dump a MAC address to character buffer.
void	snShowMac (char *buf, size_t maxlen, const MACADR &ma)
	Dump a MAC address to character buffer (reference version)
void	MacToID (MACADR *ma, char *IDBuf)
	Write 6 character ID string based on unique portion of MAC.
void	outbyte (char c)
	Write out a single, unbuffered byte to stdio.
void	print (const char *str)
	Write out a zero-terminated, unbuffered string.
void	putnum (int i)
	Write out a hexadecimal, unbuffered number to stdio.
void	putbytenum (unsigned char c)
	Write out a hexadecimal, unbuffered byte to stdio.
IPADDR4	AsciiToIp4 (const char *p)
	Convert an ASCII IPv4 string to an IP address.
MACADR	AsciiToMac (const char *p)
	Convert an ASCII MAC address string to a MAC address.
BOOL	ValidIPv4 (const char *p)
	Validate if a string contains a valid IPv4 address.
void	ShowIP4 (const IPADDR4 ia)
	Dump an IPv4 address in ASCII IP string format to stdio.
int	snShowIP4 (char *buf, size_t maxlen, const IPADDR4 ia)
	Dump an IPv4 address in ASCII IP string format to character buffer.
void	ShowIP6 (const IPADDR &ia)
	Dump an IPv6 address in ASCII IP string format to stdio.
int	snShowIP6 (char *buf, size_t maxlen, const IPADDR &ia)
	Dump an IPv6 address in ASCII IP string format to character buffer.
uint32_t	GetPreciseTime (void)
	Gets the time tick since system start at a higher resolution.
unsigned long long	Get_msec ()
	Returns the number of milliseconds as a 64-bit value.
int	kill (int pid, int sig)
	Send a signal to a process.
void	_exit (int i)
	Terminate the calling process.
int	_fini (void)
	Finalization function.
unsigned char *	convertBinaryToHexAscii (unsigned char *fromBufferPtr, unsigned int fromByteCount, unsigned char *toBufferPtr, unsigned int toByteCount)
	Convert binary data to hexadecimal ASCII representation.
unsigned char *	convertHexAsciiToBinary (unsigned char *fromBufferPtr, unsigned int fromByteCount, unsigned char *toBufferPtr, unsigned int toByteCount)
	Convert hexadecimal ASCII string to binary data.
const char *	bufnstr (const char *search, const char *target, size_t len)
	Search for a C string in an arbitrary memory blob that may contain NULL chars.

Detailed Description

NetBurner Utilities API.