| 1 |
SRT Core |
| 2 |
======== |
| 3 |
|
| 4 |
These files are contents of the SRT library. Beside files that are used exclusively |
| 5 |
and internally by the library, this directory also contains: |
| 6 |
|
| 7 |
- common files: usually header files, which can be used also by other projects, |
| 8 |
even if they don't link against SRT |
| 9 |
|
| 10 |
- public and protected header files - header files for the library, which will |
| 11 |
be picked up from here |
| 12 |
|
| 13 |
Which header files are public, protected and private, it's defined in the manifest |
| 14 |
file together with all source files that the SRT library comprises of: `filelist.maf`. |
| 15 |
|
| 16 |
|
| 17 |
Common files |
| 18 |
============ |
| 19 |
|
| 20 |
This directory holds the files that may be used separately by both SRT library |
| 21 |
itself and the internal applications. |
| 22 |
|
| 23 |
Source files are added to SRT library, so apps don't have to use them. However |
| 24 |
these source files might be used by some internal applications that do not |
| 25 |
link against SRT library. |
| 26 |
|
| 27 |
Header files contained here might be required by internal applications no |
| 28 |
matter if they link against SRT or not. They are here because simultaneously |
| 29 |
they are used also by the SRT library. |
| 30 |
|
| 31 |
|
| 32 |
Utilities |
| 33 |
========= |
| 34 |
|
| 35 |
1. threadname.h |
| 36 |
|
| 37 |
This is a utility that is useful for debugging and it allows a thread to be given |
| 38 |
a name. This name is used in the logging messages, as well as you can see it also |
| 39 |
inside the debugger. |
| 40 |
|
| 41 |
This is currently supported only on Linux; some more portable and more reliable |
| 42 |
way is needed. |
| 43 |
|
| 44 |
2. utilities.h |
| 45 |
|
| 46 |
A set of various reusable components, all defined as C++ classes or C++ inline |
| 47 |
functions. |
| 48 |
|
| 49 |
3. `netinet_any.h` |
| 50 |
|
| 51 |
This defines a `sockaddr_any` type, which simplifies dealing with the BSD socket API |
| 52 |
using `sockaddr`, `sockaddr_in` and `sockaddr_in6` structures. |
| 53 |
|
| 54 |
|
| 55 |
Compat and portability |
| 56 |
====================== |
| 57 |
|
| 58 |
1. `srt_compat.h` |
| 59 |
|
| 60 |
This part contains some portability problem resolutions, including: |
| 61 |
- `strerror` in a version that is both portable and thread safe |
| 62 |
- `localtime` in a version that is both portable and thread safe |
| 63 |
|
| 64 |
2. win directory |
| 65 |
|
| 66 |
This contains various header files that are used on Windows platform only. |
| 67 |
They provide various facilities available OOTB on POSIX systems. |
| 68 |
|
| 69 |
3. `platform_sys.h` |
| 70 |
|
| 71 |
This is a file that is responsible to include whatever system include |
| 72 |
files must be included for whatever system API must be provided for |
| 73 |
the needs of SRT library. This is a part of public headers. |
| 74 |
|
| 75 |
|