OSDEP API

This module provides a portable cross-platform abstraction layer. By including "osdep.h", you will include most common O/S headers and define a set of useful cross-platform constants.

Function Index

Typedef Index

Offset	Signed file offset data type.
Socket	Argument for sockets.
Socklen	Size to hold the length of a socket address.
Ticks	Elapsed time data type.
Time	Time in milliseconds since Jan 1, 1970.
bool	Boolean data type.
cchar	Constant char data type.
cint	Constant int data type.
cuchar	Unsigned char data type.
cushort	Constant unsigned short data type.
cvoid	Constant void data type.
int16	Integer 16 bits data type.
int32	Integer 32 bits data type.
int8	Integer 8 bits data type.
schar	Signed char data type.
size_t	Unsigned integral type.
ssize	Signed integer size field large enough to hold a pointer offset.
time_t	Unsigned time type.
uchar	Unsigned char data type.
uint	Unsigned integer (machine dependent bit size) data type.
uint16	Unsigned integer 16 bits data type.
uint32	Unsigned integer 32 bits data type.
uint8	Unsigned integer 8 bits data type.
ulong	Unsigned long (machine dependent bit size) data type.
ushort	Unsigned short data type.
wsize	Windows uses uint for write/read counts (Ugh!).

Defines

#define	ME_BIG_ENDIAN   2
	Big endian byte ordering.
#define	ME_BUFSIZE   4096
	Reasonable size for buffers.
#define	ME_CPU_ARM   1
	Arm.
#define	ME_CPU_ARM64   2
	Arm64.
#define	ME_CPU_ITANIUM   3
	Intel Itanium.
#define	ME_CPU_MIPS   6
	Mips.
#define	ME_CPU_MIPS64   7
	Mips 64.
#define	ME_CPU_PPC   8
	Power PC.
#define	ME_CPU_PPC64   9
	Power PC 64.
#define	ME_CPU_RISCV   13
	RiscV.
#define	ME_CPU_RISCV64   14
	RiscV64.
#define	ME_CPU_SH   12
	SuperH.
#define	ME_CPU_SPARC   10
	Sparc.
#define	ME_CPU_TIDSP   11
	TI DSP.
#define	ME_CPU_X64   5
	AMD64 or EMT64.
#define	ME_CPU_X86   4
	X86.
#define	ME_CPU_XTENSA   15
	Xtensa / ESP32.
#define	ME_DEBUG   0
	Default to a debug build.
#define	ME_LITTLE_ENDIAN   1
	Little endian byte ordering.
#define	ME_MAX_ARGC   32
	Maximum number of command line args if using MAIN().
#define	ME_MAX_FNAME   256
	Reasonable filename size.
#define	ME_MAX_PATH   1024
	Reasonable path size.
#define	ME_STACK_SIZE   (32 * 1024)
	Default thread stack size (0 means use system default).
#define	OSDEP_USE_ME   1
	Operating system dependent layer that provides a portable cross-platform abstraction layer.
#define	TPS   1000
	Time/Ticks units per second (milliseconds).

Typedefs

typedef char bool

Boolean data type.

API Stability:

Stable.

typedef const char cchar

Constant char data type.

API Stability:

Stable.

typedef const int cint

Constant int data type.

API Stability:

Stable.

typedef const unsigned char cuchar

Unsigned char data type.

API Stability:

Stable.

typedef const unsigned short cushort

Constant unsigned short data type.

API Stability:

Stable.

typedef const void cvoid

Constant void data type.

API Stability:

Stable.

typedef short int16

Integer 16 bits data type.

API Stability:

Stable.

typedef int int32

Integer 32 bits data type.

API Stability:

Stable.

typedef char int8

Integer 8 bits data type.

API Stability:

Stable.

typedef int64 Offset

Signed file offset data type.

Supports large files greater than 4GB in size on all systems

API Stability:

Stable.

typedef signed char schar

Signed char data type.

API Stability:

Stable.

typedef long size_t

Unsigned integral type.

Equivalent in size to void*

typedef int Socket

Argument for sockets.

API Stability:

Stable.

typedef int Socklen

Size to hold the length of a socket address.

API Stability:

Stable.

typedef ssize_t ssize

Signed integer size field large enough to hold a pointer offset.

API Stability:

Stable.

typedef int64 Ticks

Elapsed time data type.

Stores time in milliseconds from some arbitrary start epoch

API Stability:

Stable.

typedef int64 Time

Time in milliseconds since Jan 1, 1970.

API Stability:

Stable.

typedef long time_t

Unsigned time type.

Time in seconds since Jan 1, 1970

typedef unsigned char uchar

Unsigned char data type.

API Stability:

Stable.

typedef unsigned int uint

Unsigned integer (machine dependent bit size) data type.

API Stability:

Stable.

typedef unsigned short uint16

Unsigned integer 16 bits data type.

API Stability:

Stable.

typedef unsigned int uint32

Unsigned integer 32 bits data type.

API Stability:

Stable.

typedef unsigned char uint8

Unsigned integer 8 bits data type.

API Stability:

Stable.

typedef unsigned long ulong

Unsigned long (machine dependent bit size) data type.

API Stability:

Stable.

typedef unsigned short ushort

Unsigned short data type.

API Stability:

Stable.

typedef ssize wsize

Windows uses uint for write/read counts (Ugh!).

API Stability:

Stable.

Functions