Skip to content

Latest commit

 

History

History
152 lines (144 loc) · 3.52 KB

POSIX.md

File metadata and controls

152 lines (144 loc) · 3.52 KB
Raw

Build with POSIX API

This file is part of AREG SDK.
Copyright (c) Aregtech, 2017-2021
Contact: info[at]aregtech.com
Website: https://www.aregtech.com

This document describes the instruction to compile AREG SDK and example source codes under Linux or any other POSIX_ 32- or 64-bit platform. The minimum requirement to run an application built with the AREG SDK on the target device are 256KB of free RAM and 2MB of free storage space.

The AREG SDK sources can be compiled under Linux or any other POSIX platform by using Eclipse IDE. Open Eclipse IDE for C/C++ and import one or all projects located in:

  • <areg-sdk-root>/framework/areg/ to build the AREG framework.
  • <areg-sdk-root>/framework/mcrouter/ to build the multicast router.
  • <areg-sdk-root>/examples/xxx to build examples.

Select preferred toolchain to build project(s). By default, it is set GNU GCC compile with the GCC compiler under Linux. AREG SDK sources can be compiled as a static or a shared library. By default, it is a static library. Integrate AREG framework in your project(s) and make sure that you link with areg library. The HOWTO.md document contains detailed description to import Eclipse projects and to integrate AREG framework in the existing or new project.

To build AREG framework with POSIX API, define POSIX (or _POSIX) preprocessor directive.

Other preprocessor directives to compile:

  • DEBUG to compile with debug configuration.
  • NDEBUG to compile with release configuration.
  • ENABLE_TRACES to compile with enabled logging.
  • EXP_AREG_LIB to compile the AREG framework as a static library.
  • EXP_AREG_DLL to compile the AREG frmework as a shared library.
  • IMP_AREG_LIB to link a project with the AREG framework static library.
  • IMP_AREG_DLL to link a project with the AREG framework shared library.

AREG SDK requires POSIX1.c API for multithreading and synchronization.

The list of POSIX API used in AREG SDK (including multicast message router)

accept
access
bind
ceil
chdir
clock_gettime
close
connect
execl
fclose
FD_ISSET
FD_SET
FD_ZERO
fgets
floor
fopen
free
freeaddrinfo
fsync
ftruncate
getaddrinfo
getcwd
getenv
getpeername
getpid
getsockopt
gmtime
gmtime_r
htons
inet_addr
inet_ntoa
inet_ntop
ioctl
isalnum
listen
localtime
localtime_r
lseek
mkdir
mkstemp
mktime
nanosleep
ntohs
open
opendir
poll
printf
pthread_attr_destroy
pthread_attr_init
pthread_attr_setdetachstate
pthread_cancel
pthread_cond_destroy
pthread_cond_init
pthread_cond_signal
pthread_cond_timedwait
pthread_cond_wait
pthread_condattr_destroy
pthread_condattr_init
pthread_condattr_setpshared
pthread_create
pthread_mutex_destroy
pthread_mutex_init
pthread_mutex_lock
pthread_mutex_timedlock
pthread_mutex_trylock
pthread_mutex_unlock
pthread_mutexattr_destroy
pthread_mutexattr_init
pthread_mutexattr_settype
pthread_self
pthread_setcancelstate
pthread_setname_np (Linux)
pthread_setschedparam
pthread_spin_destroy
pthread_spin_init
pthread_spin_lock
pthread_spin_trylock
pthread_spin_unlock
read
readdir
realpath
recv
rename
rmdir
scanf
sched_get_priority_max
sched_get_priority_min
select
send
setsockopt
shutdown
signal
snprintf
socket
sprintf
stat
strftime
strtod
strtof
strtol
strtoll
strtoul
strtoull
swprintf
timer_create
timer_delete
timer_settime
unlink
va_end
va_start
vsnprintf
wcstof
wcstol
wcstoll
wcstoul
wcstoull
write

Make sure that the target platform supports all of these functions and macro.