--- /dev/null
+*.o
+test/.deps
+test/include
+test/test_suite
+doc/reference
+doc/include
--- /dev/null
+
+
+# prefix for installing the binaries and headers
+prefix=/usr/local
+
+
+
+default: all
+
+all: test memtest
+
+install:
+ $(MAKE) -C src $@
+
+doc:
+ $(MAKE) -C doc $@
+
+test memtest: all
+ $(MAKE) -C test $@
+
+clean:
+ $(MAKE) -C src $@
+ $(MAKE) -C doc $@
+ $(MAKE) -C test $@
+
+.PHONY: default all install doc test memtest clean
+
+
--- /dev/null
+# Doxyfile 1.5.6
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME = posixx
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER = 0.1
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = reference
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
+# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
+# and Ukrainian.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = YES
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH = include/
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH = include/
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF = YES
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the DETAILS_AT_TOP tag is set to YES then Doxygen
+# will output the detailed description near the top, like JavaDoc.
+# If set to NO, the detailed description appears after the member
+# documentation.
+
+DETAILS_AT_TOP = YES
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = YES
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen to replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING = YES
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = YES
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = YES
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = YES
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = YES
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = NO
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = NO
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page. This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = include
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+
+FILE_PATTERNS =
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output. If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code. Otherwise they will link to the documentstion.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = YES
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET =
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS = YES
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+
+GENERATE_DOCSET = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE = 4
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to FRAME, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+# probably better off using the HTML help feature. Other possible values
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
+# and Class Hiererachy pages using a tree view instead of an ordered list;
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
+# disables this behavior completely. For backwards compatibility with previous
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
+# respectively.
+
+GENERATE_TREEVIEW = FRAME
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE = 10
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = YES
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader. This is useful
+# if you want to understand what is going on. On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = YES
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
+# the parser if not removed.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
+
+CLASS_DIAGRAMS = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT = YES
+
+# By default doxygen will write a font called FreeSans.ttf to the output
+# directory and reference it in all dot files that doxygen generates. This
+# font does not include all possible unicode characters however, so when you need
+# these (or just want a differently looking font) you can specify the font name
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
+# which can be done by putting it in a standard location or by setting the
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
+# containing the font.
+
+DOT_FONTNAME = FreeSans
+
+# By default doxygen will tell dot to use the output directory to look for the
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
+# different font using DOT_FONTNAME you can set the path where dot
+# can find it using this tag.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK = YES
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = NO
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH = NO
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is enabled by default, which results in a transparent
+# background. Warning: Depending on the platform used, enabling this option
+# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
+# become hard to read).
+
+DOT_TRANSPARENT = YES
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+
+# The SEARCHENGINE tag specifies whether or not a search engine should be
+# used. If set to NO the values of all tags below this one will be ignored.
+
+SEARCHENGINE = NO
--- /dev/null
+
+
+# prefix for installing the binaries and headers
+prefix=/usr/local
+
+
+ifneq ($(V), 1)
+NICE_DOXY = @echo " DOXYGEN"; (cat Doxyfile; echo "QUIET=YES") | doxygen -
+NICE_CLEAN = @echo " CLEAN"; $(RM)
+NICE = @
+else
+NICE_DOXY = doxygen
+NICE_CLEAN = $(RM) -v
+NICE =
+endif
+
+
+default: all
+
+all: doc
+
+doc: include
+ $(NICE_DOXY)
+
+install: install-man install-html
+
+install-man: doc
+ $(NICE) for f in `find reference/man -type f | cut -b11-`; do \
+ echo " INSTALL $(prefix)/share/$$f"; \
+ install -m 0644 -D reference/$$f $(prefix)/share/$$f; \
+ done
+
+install-html: doc
+ $(NICE) for f in `find reference/html -type f | cut -b11-`; do \
+ echo " INSTALL $(prefix)/share/doc/posixx/$$f"; \
+ install -m 0644 -D reference/$$f $(prefix)/share/doc/posixx/$$f; \
+ done
+
+include:
+ @mkdir -p include
+ @ln -fs ../../src include/posixx
+
+clean:
+ $(NICE_CLEAN) -r reference include
+
+.PHONY: default all doc install install-man install-doc clean
+
+
--- /dev/null
+
+# XXX: The cut pipe is to strip the leading "./" from find results. It's
+# a little ugly but I couldn't find a better way to get a list of all
+# headers in the directory (recursively).
+HEADERS = $(shell find -name '*.hpp' | cut -b3-)
+HDRPATH = posixx
+
+
+ifneq ($(V), 1)
+NICE_NOP =
+NICE = @
+else
+NICE_NOP = @echo "Nothing to do, headers only"
+NICE =
+endif
+
+
+default: all
+
+all:
+ $(NICE_NOP)
+
+install-headers: $(HEADERS)
+ $(NICE) for f in $(HEADERS); do \
+ echo " INSTALL $(prefix)/include/$(HDRPATH)/$$f"; \
+ install -m 0644 -D $$f $(prefix)/include/$(HDRPATH)/$$f; \
+ done
+
+install: install-headers
+
+clean:
+ $(NICE_NOP)
+
+.PHONY: default all clean install-headers install
+
--- /dev/null
+#ifndef POSIXX_BASIC_SOCKET_HPP_
+#define POSIXX_BASIC_SOCKET_HPP_
+
+#include "error.hpp" // posixx::error
+#include "static_assert.hpp" // static_assert
+
+#include <string> // std::string
+#include <utility> // std::pair
+#include <sys/socket.h> // socket, send, recv, etc.
+
+/// @file
+
+/// POSIX thin wrapper
+namespace posixx {
+
+/// BSD socket API
+namespace socket {
+
+/**
+ * Socket type.
+ *
+ * @see socket().
+ * @see socket(7).
+ */
+enum type
+{
+ /**
+ * Connectionless, unreliable messages of a fixed maximum
+ * length.
+ */
+ DGRAM = SOCK_DGRAM,
+ /**
+ * Reliable datagram layer that does not guarantee ordering.
+ */
+ RDM = SOCK_RDM,
+ /**
+ * Sequenced, reliable, two-way connection-based datagram
+ * transmission.
+ *
+ * Sequenced, reliable, two-way connection-based data
+ * transmission path for datagrams of fixed maximum length;
+ * a consumer is required to read an entire packet with each
+ * read system call.
+ */
+ SEQPACKET = SOCK_SEQPACKET,
+ /**
+ * Sequenced, reliable, two-way, connection-based byte streams.
+ *
+ * An out-of-band data transmission mechanism may be supported.
+ */
+ STREAM = SOCK_STREAM,
+ /**
+ * Raw network protocol access.
+ */
+ RAW = SOCK_RAW
+};
+
+/**
+ * Shutdown mode.
+ *
+ * @see socket::shutdown().
+ * @see shutdown(2).
+ */
+enum shutdown_mode
+{
+ RD = SHUT_RD, ///< Further receptions will be disallowed.
+ WR = SHUT_WR, ///< Further transmissions will be disallowed.
+ RDWR = SHUT_RDWR ///< Both will be disallowed.
+};
+
+/**
+ * Generic socket interface.
+ *
+ * This class is thread-safe as it just stores a file descriptor for the socket.
+ *
+ * @see socket(7)
+ */
+template < typename TSockTraits >
+struct basic_socket
+{
+
+ /// Traits used by this socket
+ typedef TSockTraits traits;
+
+ /**
+ * Create an endpoint for communication.
+ *
+ * @param type Type of socket.
+ * @param protocol Protocol number.
+ *
+ * @see socket(2), socket(7)
+ */
+ basic_socket(type type, int protocol = 0) throw (error);
+
+ /**
+ * Create a socket instance from a file descriptor.
+ *
+ * This is mainly used by the accept() method and pair() function and
+ * should be used with care because it takes "ownership" of the file
+ * descriptor (it's closed by the destructor).
+ *
+ * Use with care.
+ *
+ * @param fd Socket file descriptor.
+ */
+ explicit basic_socket(int fd) throw ();
+
+ /**
+ * Bind a name to the socket.
+ *
+ * @param addr Protocol-dependant name to bind on.
+ *
+ * @see bind(2)
+ */
+ void bind(const typename TSockTraits::sockaddr& addr) throw (error);
+
+ /**
+ * Initiate a connection on the socket.
+ *
+ * @param addr Protocol-dependant name to connect to.
+ *
+ * @see connect(2)
+ */
+ void connect(const typename TSockTraits::sockaddr& addr) throw (error);
+
+ /**
+ * Get the socket name.
+ *
+ * @return Protocol-dependant name binded.
+ *
+ * @see getsockname(2)
+ */
+ typename TSockTraits::sockaddr name() const throw (error);
+
+ /**
+ * Get the name of connected peer socket.
+ *
+ * @return Protocol-dependant name of the peer.
+ *
+ * @see getpeername(2)
+ */
+ typename TSockTraits::sockaddr peer_name() const throw (error);
+
+ /**
+ * Send a message on the socket.
+ *
+ * @param buf Message buffer.
+ * @param n Message length.
+ * @param flags Sending options.
+ *
+ * @return The number of characters sent.
+ *
+ * @see send(2), connect()
+ *
+ * @todo make an enum for the flags (are they protocol-dependant?)
+ */
+ ssize_t send(const void* buf, size_t n, int flags = 0) throw (error);
+
+ /**
+ * Receive a message on the socket.
+ *
+ * @param buf Message buffer.
+ * @param n Maximum message length.
+ * @param flags Receiving options.
+ *
+ * @return The number of characters received.
+ *
+ * @see recv(2), connect()
+ *
+ * @todo make an enum for the flags (are they protocol-dependant?)
+ */
+ ssize_t recv(void* buf, size_t n, int flags = 0) throw (error);
+
+ /**
+ * Send a message on the socket to a specific name.
+ *
+ * @param buf Message buffer.
+ * @param n Message length.
+ * @param to Name to send the message to.
+ * @param flags Sending options.
+ *
+ * @return The number of characters sent.
+ *
+ * @see sendto(2)
+ *
+ * @todo make an enum for the flags (are they protocol-dependant?)
+ */
+ ssize_t send(const void* buf, size_t n,
+ const typename TSockTraits::sockaddr& to,
+ int flags = 0) throw (error);
+
+ /**
+ * Receive a message on the socket from a specific name.
+ *
+ * @param buf Message buffer.
+ * @param n Maximum message length.
+ * @param from Name to receive the message from.
+ * @param flags Receiving options.
+ *
+ * @return The number of characters received.
+ *
+ * @see recvfrom(2)
+ *
+ * @todo make an enum for the flags (are they protocol-dependant?)
+ */
+ ssize_t recv(void* buf, size_t n, typename TSockTraits::sockaddr& from,
+ int flags = 0) throw (error);
+
+ /**
+ * Get options on the socket.
+ *
+ * @param level Level at which the option reside.
+ * @param optname Name of the option.
+ * @param opt Where to store the option value.
+ *
+ * @see getsockopt(2)
+ */
+ template< typename TSockOpt >
+ void getsockopt(int level, int optname, TSockOpt& opt) const
+ throw (error);
+
+ /**
+ * Set options on the socket.
+ *
+ * @param level Level at which the option reside.
+ * @param optname Name of the option.
+ * @param opt New option value.
+ *
+ * @see setsockopt(2)
+ */
+ template< typename TSockOpt >
+ void setsockopt(int level, int optname, const TSockOpt& opt)
+ throw (error);
+
+ /**
+ * Get option on the socket (type-safe).
+ *
+ * Note that template argument must be specified explicitly, and the
+ * template argument must be a valid socket option, which is a struct
+ * with 5 members: level, optname, read, write and type. level and
+ * optname must be the corresponding SOL_* and SO_* constants. read and
+ * write must be boolean constants indicating if the options can be
+ * read or written. type should be the type of the option's argument.
+ *
+ * See sockopt namespaces for available options.
+ *
+ * @return Option value
+ *
+ * @see getsockopt()
+ */
+ template< typename TSockOpt >
+ typename TSockOpt::type opt() const throw (error);
+
+ /**
+ * Set option on the socket (type-safe).
+ *
+ * See getsockopt() for details on how options can be constructed.
+ *
+ * @param opt Option value
+ *
+ * @see setsockopt()
+ */
+ template< typename TSockOpt >
+ void opt(const typename TSockOpt::type& opt) throw (error);
+
+ /**
+ * Listen for connections on the socket.
+ *
+ * @param backlog Maximum length the queue of pending
+ * connections may grow to.
+ *
+ * @see accept(), listen(2)
+ */
+ void listen(int backlog = 5) throw (error);
+
+ /**
+ * Accept a connection on the socket.
+ *
+ * @see listen(), accept(2)
+ */
+ basic_socket* accept() throw (error);
+
+ /**
+ * Accept a connection on the socket.
+ *
+ * @param addr Address of the peer socket, as known to the
+ * communications layer.
+ *
+ * @see listen(), accept(2)
+ */
+ basic_socket* accept(typename TSockTraits::sockaddr& addr)
+ throw (error);
+
+ /**
+ * Shut down part of a full-duplex connection.
+ *
+ * @param how How the connection is shutted down.
+ *
+ * @see shutdown(2)
+ */
+ void shutdown(shutdown_mode how = RDWR) throw (error);
+
+ /**
+ * Close the socket file descriptor.
+ *
+ * @see close(2)
+ */
+ void close() throw (error);
+
+ /**
+ * Destructor.
+ *
+ * Closes the socket.
+ *
+ * @see shutdown(), close()
+ */
+ ~basic_socket() throw ();
+
+ // Higher level API
+
+ /**
+ * Send a message on the socket.
+ *
+ * The message could be any struct and is sent as binary data without
+ * any concerns about the byte-order.
+ *
+ * This is a shortcut for the low-level send() method, where the
+ * message length is calculated as sizeof(TPacket).
+ *
+ * Of course, TPacket should be a POD type, without pointers or
+ * references.
+ *
+ * This method loops on the low-level send() until all the data is
+ * sent, or throws an exception if the send() can't be completed.
+ *
+ * @param packet Message struct to send.
+ * @param flags Sending options.
+ *
+ * @see send()
+ *
+ * @todo make an enum for the flags (are they protocol-dependant?)
+ */
+ template< typename TPacket >
+ void send_struct(const TPacket& packet, int flags = MSG_NOSIGNAL)
+ throw (error);
+
+ /**
+ * Receive a message on the socket.
+ *
+ * The message could be any struct and is received as binary data
+ * without any concerns about the byte-order.
+ *
+ * This is a shortcut for the low-level recv() method, where the
+ * message length is calculated as sizeof(TPacket).
+ *
+ * Of course, TPacket should be a POD type, without pointers or
+ * references.
+ *
+ * This method loops on the low-level recv() until all the data is
+ * received, or throws an exception if the recv() can't be completed.
+ *
+ * @param packet Message struct to receive on.
+ * @param flags Sending options.
+ *
+ * @see recv()
+ *
+ * @todo make an enum for the flags (are they protocol-dependant?)
+ */
+ template< typename TPacket >
+ void recv_struct(TPacket& packet,
+ int flags = MSG_NOSIGNAL | MSG_WAITALL) throw (error);
+
+ /**
+ * Send a message on the socket to a specific name.
+ *
+ * This method behaves the same as send(const TPacket& packet, int
+ * flags) but sending to a specific name.
+ *
+ * @param packet Message struct to send.
+ * @param to Name to send the message to.
+ * @param flags Sending options.
+ *
+ * @see send()
+ *
+ * @todo make an enum for the flags (are they protocol-dependant?)
+ */
+ template< typename TPacket >
+ void send_struct(const TPacket& packet,
+ const typename TSockTraits::sockaddr& to,
+ int flags = MSG_NOSIGNAL) throw (error);
+
+ /**
+ * Receive a message on the socket from a specific name.
+ *
+ * This method behaves the same as recv(TPacket& packet, int flags) but
+ * receiving from a specific name.
+ *
+ * @param packet Message struct to receive to.
+ * @param from Name to receive the message from.
+ * @param flags Receiving options.
+ *
+ * @see recv()
+ *
+ * @todo make an enum for the flags (are they protocol-dependant?)
+ */
+ template< typename TPacket >
+ void recv_struct(TPacket& packet, typename TSockTraits::sockaddr& from,
+ int flags = MSG_NOSIGNAL | MSG_WAITALL) throw (error);
+
+ /**
+ * Get the socket file descriptor.
+ *
+ * You should be careful when using the socket file descriptor, and you
+ * should not close it since it's closed by the destructor.
+ *
+ * @return Socket file descriptor.
+ */
+ int fd() const throw ();
+
+ /**
+ * Convert the socket to a file descriptor.
+ *
+ * This is really a shortcut to fd(), useful to pass a socket to a low
+ * level C function.
+ *
+ * @return Socket file descriptor.
+ */
+ operator int () const throw ();
+
+private:
+
+ /// Hidden copy constructor (it has non-copiable behavior).
+ basic_socket(const basic_socket& s);
+
+ /// Hidden assign operator (it has non-assignable behavior).
+ basic_socket& operator=(const basic_socket& s);
+
+ /// Socket file descriptor.
+ int _fd;
+
+};
+
+/**
+ * Create a pair of connected sockets.
+ *
+ * @param type Type of socket.
+ * @param protocol Protocol number.
+ *
+ * @return The new connected pair of sockets.
+ *
+ * @see socketpair(2)
+ */
+template < typename TSock >
+inline
+std::pair< TSock*, TSock* > pair(type type, int protocol = 0) throw (error);
+
+} } // namespace posixx::socket
+
+
+
+
+template < typename TSock >
+std::pair< TSock*, TSock* > posixx::socket::pair(type type, int protocol)
+ throw (posixx::error)
+{
+ int fds[2];
+ if (::socketpair(TSock::traits::PF, type, protocol, fds) == -1)
+ throw error("socketpair");
+ return std::make_pair(new TSock(fds[0]), new TSock(fds[1]));
+}
+
+
+template< typename TSockTraits >
+inline
+posixx::socket::basic_socket< TSockTraits >::basic_socket(int fd) throw ():
+ _fd(fd)
+{
+}
+
+template< typename TSockTraits >
+inline
+posixx::socket::basic_socket< TSockTraits >::basic_socket(type type,
+ int protocol) throw (posixx::error)
+{
+ _fd = ::socket(TSockTraits::PF, type, protocol);
+ if (_fd == -1)
+ throw error("socket");
+}
+
+template< typename TSockTraits >
+inline
+void posixx::socket::basic_socket< TSockTraits >::bind(
+ const typename TSockTraits::sockaddr& addr)
+ throw (posixx::error)
+{
+ if (::bind(_fd, reinterpret_cast< const ::sockaddr* >(&addr),
+ addr.length()) == -1)
+ throw error("bind");
+}
+
+template< typename TSockTraits >
+inline
+void posixx::socket::basic_socket< TSockTraits >::connect(
+ const typename TSockTraits::sockaddr& addr)
+ throw (posixx::error)
+{
+ if (::connect(_fd, reinterpret_cast< const ::sockaddr* >(&addr),
+ addr.length()) == -1)
+ throw error("connect");
+}
+
+template< typename TSockTraits >
+inline
+typename TSockTraits::sockaddr posixx::socket::basic_socket< TSockTraits >::name()
+ const throw (posixx::error)
+{
+ typename TSockTraits::sockaddr addr;
+ socklen_t len = sizeof(typename TSockTraits::sockaddr);
+ // TODO assert len == sizeof(typename TSockTraits::sockaddr)
+ if (::getsockname(_fd, reinterpret_cast< ::sockaddr* >(&addr), &len) == -1)
+ throw error("getsockname");
+ return addr;
+}
+
+template< typename TSockTraits >
+inline
+typename TSockTraits::sockaddr
+posixx::socket::basic_socket< TSockTraits >::peer_name() const throw (posixx::error)
+{
+ typename TSockTraits::sockaddr addr;
+ socklen_t len = sizeof(typename TSockTraits::sockaddr);
+ // TODO assert len == sizeof(typename TSockTraits::sockaddr)
+ if (::getpeername(_fd, reinterpret_cast< ::sockaddr* >(&addr), &len) == -1)
+ throw error("getpeername");
+ return addr;
+}
+
+template< typename TSockTraits >
+inline
+ssize_t posixx::socket::basic_socket< TSockTraits >::send(const void* buf,
+ size_t n, int flags) throw (posixx::error)
+{
+ ssize_t s = ::send(_fd, buf, n, flags);
+ if (s == -1)
+ throw error("send");
+ if (s == 0)
+ throw error("send connection shutdown"); // XXX
+ return s;
+}
+
+template< typename TSockTraits >
+inline
+ssize_t posixx::socket::basic_socket< TSockTraits >::recv(void* buf, size_t n, int flags)
+ throw (posixx::error)
+{
+ ssize_t s = ::recv(_fd, buf, n, flags);
+ if (s == -1)
+ throw error("recv");
+ if (s == 0)
+ throw error("recv connection shutdown"); // XXX
+ return s;
+}
+
+template< typename TSockTraits >
+inline
+ssize_t posixx::socket::basic_socket< TSockTraits >::send(const void* buf,
+ size_t n, const typename TSockTraits::sockaddr& to, int flags)
+ throw (posixx::error)
+{
+ ssize_t s = ::sendto(_fd, buf, n, flags,
+ reinterpret_cast< const ::sockaddr* >(&to),
+ to.length());
+ if (s == -1)
+ throw error("sendto");
+ if (s == 0) {
+ error e("sendto client shutdown"); // XXX
+ e.no = 0;
+ throw e;
+ }
+ return s;
+}
+
+template< typename TSockTraits >
+inline
+ssize_t posixx::socket::basic_socket< TSockTraits >::recv(void* buf, size_t n,
+ typename TSockTraits::sockaddr& from, int flags)
+ throw (posixx::error)
+{
+ socklen_t len = sizeof(typename TSockTraits::sockaddr);
+ ssize_t s = ::recvfrom(_fd, buf, n, flags,
+ reinterpret_cast< ::sockaddr* >(&from), &len);
+ if (s == -1)
+ throw error("recvfrom");
+ if (s == 0) {
+ error e("recvfrom client shutdown"); // XXX
+ e.no = 0;
+ throw e;
+ }
+ return s;
+}
+
+/*
+ template< typename TSockTraits >
+ inline
+ ssize_t posixx::socket::basic_socket< TSockTraits >::send(const msghdr* msg, int flags)
+ {
+ ssize_t s = ::sendmsg(_fd, msg, flags);
+ if (s == -1)
+ throw error("sendmsg");
+ if (s == 0)
+ throw error("send");
+ return s;
+ }
+
+ template< typename TSockTraits >
+ inline
+ ssize_t posixx::socket::basic_socket< TSockTraits >::recv(struct msghdr* msg, int flags)
+ {
+ ssize_t s = ::recvmsg(_fd, msg, flags);
+ if (s == -1)
+ throw error("recvmsg");
+ if (s == 0)
+ throw error("send");
+ return s;
+ }
+ */
+
+template< typename TSockTraits >
+template< typename TSockOpt >
+inline
+void posixx::socket::basic_socket< TSockTraits >::getsockopt(int level, int optname,
+ TSockOpt& opt) const throw (posixx::error)
+{
+ socklen_t len = sizeof(TSockOpt);
+ if (::getsockopt(_fd, level, optname, &opt, &len) == -1) // TODO assert len == sizeof(TSockOpt)
+ throw error("getsockopt");
+}
+
+template< typename TSockTraits >
+template< typename TSockOpt >
+inline
+void posixx::socket::basic_socket< TSockTraits >::setsockopt(int level, int optname,
+ const TSockOpt& opt) throw (posixx::error)
+{
+ if (::setsockopt(_fd, level, optname, &opt, sizeof(TSockOpt)) == -1)
+ throw error("setsockopt");
+}
+
+template< typename TSockTraits >
+template< typename TSockOpt >
+inline
+typename TSockOpt::type posixx::socket::basic_socket< TSockTraits >::opt() const
+ throw (posixx::error)
+{
+ static_assert(TSockOpt::read, "Option is not readable");
+ typename TSockOpt::type opt;
+ socklen_t len = sizeof(opt);
+ // TODO assert len == sizeof(TSockOpt)
+ if (::getsockopt(_fd, TSockOpt::level, TSockOpt::optname, &opt, &len) == -1)
+ throw error("getsockopt");
+ return opt;
+}
+
+template< typename TSockTraits >
+template< typename TSockOpt >
+inline
+void posixx::socket::basic_socket< TSockTraits >::opt(
+ const typename TSockOpt::type& opt) throw (posixx::error)
+{
+ static_assert(TSockOpt::write, "Option is not writable");
+ if (::setsockopt(_fd, TSockOpt::level, TSockOpt::optname, &opt,
+ sizeof(typename TSockOpt::type)) == -1)
+ throw error("setsockopt");
+}
+
+template< typename TSockTraits >
+inline
+void posixx::socket::basic_socket< TSockTraits >::listen(int backlog) throw (posixx::error)
+{
+ if (::listen(_fd, backlog) == -1)
+ throw error("listen");
+}
+
+template< typename TSockTraits >
+inline
+posixx::socket::basic_socket< TSockTraits >* posixx::socket::basic_socket< TSockTraits >::accept()
+ throw (posixx::error)
+{
+ int fd = ::accept(_fd, 0, 0);
+ if (fd == -1)
+ throw error("accept");
+ return new basic_socket(fd);
+}
+
+template< typename TSockTraits >
+inline
+posixx::socket::basic_socket< TSockTraits >*
+posixx::socket::basic_socket< TSockTraits >::accept(typename TSockTraits::sockaddr& addr)
+ throw (posixx::error)
+{
+ socklen_t len = sizeof(typename TSockTraits::sockaddr);
+ // TODO assert len = sizeof(typename TSockTraits::sockaddr)
+ int fd = ::accept(_fd, reinterpret_cast< ::sockaddr* >(&addr), &len);
+ if (fd == -1)
+ throw error("accept");
+ return new basic_socket(fd);
+}
+
+template< typename TSockTraits >
+inline
+void posixx::socket::basic_socket< TSockTraits >::shutdown(shutdown_mode how)
+ throw (posixx::error)
+{
+ if (::shutdown(_fd, how) == -1)
+ throw error("shutdown");
+}
+
+template< typename TSockTraits >
+inline
+void posixx::socket::basic_socket< TSockTraits >::close() throw (posixx::error)
+{
+ if (::close(_fd) == -1)
+ throw error("close");
+ _fd = -1;
+}
+
+template< typename TSockTraits >
+inline
+posixx::socket::basic_socket< TSockTraits >::~basic_socket() throw ()
+{
+ if (_fd != -1)
+ close();
+}
+
+template< typename TSockTraits >
+template< typename TPacket >
+void posixx::socket::basic_socket< TSockTraits >::send_struct(
+ const TPacket& packet, int flags) throw (posixx::error)
+{
+ ssize_t s = 0;
+ while (static_cast< unsigned >(s) < sizeof(TPacket))
+ {
+ try
+ {
+ s += send(&packet + s, sizeof(TPacket) - s, flags);
+ }
+ catch (const error& e)
+ {
+ if (e.no != EINTR && e.no != EAGAIN)
+ throw;
+ }
+ }
+ if (static_cast< unsigned >(s) != sizeof(TPacket))
+ throw error("send size not match");
+}
+
+template< typename TSockTraits >
+template< typename TPacket >
+inline
+void posixx::socket::basic_socket< TSockTraits >::recv_struct(TPacket& packet, int flags)
+ throw (posixx::error)
+{
+ ssize_t s = 0;
+ while (static_cast< unsigned >(s) < sizeof(TPacket))
+ {
+ try
+ {
+ s += recv(&packet + s, sizeof(TPacket) - s, flags);
+ }
+ catch (const error& e)
+ {
+ if (e.no != EINTR && e.no != EAGAIN && e.no != EWOULDBLOCK)
+ throw;
+ }
+ }
+ if (static_cast< unsigned >(s) != sizeof(TPacket))
+ throw error("recv size not match");
+}
+
+template< typename TSockTraits >
+template< typename TPacket >
+inline
+void posixx::socket::basic_socket< TSockTraits >::send_struct(
+ const TPacket& packet,
+ const typename TSockTraits::sockaddr& to,
+ int flags) throw (posixx::error)
+{
+ ssize_t s = 0;
+ while (static_cast< unsigned >(s) < sizeof(TPacket))
+ {
+ try
+ {
+ s += send(&packet + s, sizeof(TPacket) - s, to, flags);
+ }
+ catch (const error& e)
+ {
+ if (e.no != EINTR && e.no != EAGAIN)
+ throw;
+ }
+ }
+ if (static_cast< unsigned >(s) != sizeof(TPacket))
+ throw error("send size not match");
+}
+
+template< typename TSockTraits >
+template< typename TPacket >
+inline
+void posixx::socket::basic_socket< TSockTraits >::recv_struct(TPacket& packet,
+ typename TSockTraits::sockaddr& from, int flags)
+ throw (posixx::error)
+{
+ ssize_t s = 0;
+ while (static_cast< unsigned >(s) < sizeof(TPacket))
+ {
+ try
+ {
+ s += recv(&packet + s, sizeof(TPacket) - s, from, flags);
+ }
+ catch (const error& e)
+ {
+ if (e.no != EINTR && e.no != EAGAIN && e.no != EWOULDBLOCK)
+ throw;
+ }
+ }
+ if (static_cast< unsigned >(s) != sizeof(TPacket))
+ throw error("recv size not match");
+}
+
+template< typename TSockTraits >
+inline
+int posixx::socket::basic_socket< TSockTraits >::fd() const throw ()
+{
+ return _fd;
+}
+
+template< typename TSockTraits >
+inline
+posixx::socket::basic_socket< TSockTraits >::operator int () const throw ()
+{
+ return _fd;
+}
+
+#if 0
+
+template< typename TSockTraits >
+template< typename TPacket >
+inline
+void send(const TPacket& packet) // TODO specialize with std::string
+{
+}
+
+template< typename TSockTraits >
+template< typename TPacket >
+inline
+void recv(TPacket& packet) // TODO specialize with std::string
+{
+}
+
+template< typename TSockTraits >
+inline
+void recv(std::string& buf, size_t n)
+{
+}
+#endif
+
+#endif // _POSIXX_BASIC_SOCKET_HPP_
--- /dev/null
+#ifndef POSIXX_ERROR_HPP_
+#define POSIXX_ERROR_HPP_
+
+#include <cstring>
+#include <stdexcept>
+#include <cerrno>
+#include <string>
+
+/// @file
+
+namespace posixx {
+
+/// Posix error.
+struct error: std::runtime_error
+{
+
+ /// Default constructor, gets the error number and string from errno.
+ error() throw();
+
+ /**
+ * Constructor with a more detailed message.
+ *
+ * @param where Description about where the error was thrown.
+ */
+ explicit error(const std::string& where) throw ();
+
+ /// Destructor
+ ~error() throw();
+
+ /// Error number, as of errno.
+ int no;
+
+};
+
+} // namespace posixx
+
+
+inline
+posixx::error::error() throw():
+ std::runtime_error(strerror(errno)), no(errno)
+{
+}
+
+inline
+posixx::error::error(const std::string& where) throw ():
+ std::runtime_error(where + ": " + strerror(errno)), no(errno)
+{
+}
+
+inline
+posixx::error::~error() throw ()
+{
+}
+
+#endif // POSIXX_ERROR_HPP_
--- /dev/null
+#ifndef POSIXX_LINUX_TIPC_HPP_
+#define POSIXX_LINUX_TIPC_HPP_
+
+#include "../basic_socket.hpp" // posixx::socket
+
+#include <linux/tipc.h> // all tipc stuff
+#include <cstring> // memcpy
+
+/// @file
+
+namespace posixx {
+
+/// Linux specific functionality
+namespace linux {
+
+/// TIPC socket domain.
+namespace tipc {
+
+enum
+{
+ /// Configuration port name.
+ CFG_SRV = TIPC_CFG_SRV,
+ /// Topology discovery port name.
+ TOP_SRV = TIPC_TOP_SRV,
+ /// Name of the last reserved port.
+ RESERVED_TYPES = TIPC_RESERVED_TYPES,
+ /// Maximum message size.
+ MAX_USER_MSG_SIZE = TIPC_MAX_USER_MSG_SIZE,
+ /// Wait forever (for subscriptions).
+ WAIT_FOREVER = TIPC_WAIT_FOREVER
+};
+
+/// TIPC Address
+struct addr
+{
+
+ /// 32-bit address.
+ __u32 address;
+
+ /// Constructor
+ addr() throw ();
+
+ /**
+ * Constructor from a raw 32-bit address.
+ *
+ * @param addr Raw 32-bit address.
+ */
+ explicit addr(__u32 addr) throw ();
+
+ /**
+ * Constructor from a zone, cluster and node information.
+ *
+ * @param zone Zone.
+ * @param cluster Cluster.
+ * @param node Node.
+ */
+ addr(unsigned int zone, unsigned int cluster, unsigned int node)
+ throw ();
+
+ /// Set zone.
+ void zone(unsigned int zone) throw ();
+
+ /// Get zone.
+ unsigned int zone() const throw ();
+
+ /// Set cluster.
+ void cluster(unsigned int cluster) throw ();
+
+ /// Get cluster.
+ unsigned int cluster() const throw ();
+
+ /// Set node.
+ void node(unsigned int node) throw ();
+
+ /// Get node.
+ unsigned int node() const throw ();
+
+ /// Cast to a raw 32-bit address.
+ operator __u32 () const throw ();
+
+};
+
+/**
+ * Port Identificator.
+ *
+ * @see tipc_portid struct from linux/tipc.h.
+ */
+struct portid: tipc_portid
+{
+
+ /**
+ * Constructor.
+ *
+ * @param ref Unique ID fo the port in the address.
+ * @param node Node address.
+ */
+ portid(__u32 ref, addr node) throw ();
+
+};
+
+/**
+ * Named port.
+ *
+ * @see tipc_name struct from linux/tipc.h.
+ */
+struct name: tipc_name
+{
+ /**
+ * Constructor.
+ *
+ * @param type Type of the named port.
+ * @param instance Instance of the named port.
+ */
+ name(__u32 type, __u32 instance) throw ();
+};
+
+/**
+ * Port sequence.
+ *
+ * @see Multicast
+ * @see tipc_name_seq struct from linux/tipc.h.
+ */
+struct nameseq: tipc_name_seq
+{
+ /**
+ * Constructor.
+ *
+ * @param type Type of the sequence.
+ * @param lower Lower bound.
+ * @param upper Upper bound.
+ */
+ nameseq(__u32 type, __u32 lower, __u32 upper) throw ();
+ /**
+ * Constructor.
+ *
+ * @param type Type of the sequence.
+ * @param instance Lower and upper bound.
+ */
+ nameseq(__u32 type, __u32 instance) throw ();
+};
+
+/**
+ * Multicast port sequence.
+ *
+ * It's a port sequence just like nameseq used to simplify the use of the
+ * sockaddr.
+ *
+ * @see nameseq
+ * @see Estructura tipc_name_seq de linux/tipc.h
+ */
+struct multicast: tipc_name_seq
+{
+ /**
+ * Constructor.
+ *
+ * @param type Type of the multicast sequence.
+ * @param lower Lower bound.
+ * @param upper Upper bound.
+ */
+ multicast(__u32 type, __u32 lower, __u32 upper) throw ();
+ /**
+ * Constructor.
+ *
+ * @param type Type of the multicast sequence.
+ * @param instance Lower and upper bound.
+ */
+ multicast(__u32 type, __u32 instance) throw ();
+};
+
+/**
+ * Reasons for returned messages when recvmsg() is used.
+ *
+ * @see recvmsg(2) of TIPC documentation
+ */
+enum reason_t
+{
+ /// Not a returned message.
+ OK = TIPC_OK,
+ /// Port name doesn't exist.
+ ERR_NO_NAME = TIPC_ERR_NO_NAME,
+ /// Port ID doesn't exist.
+ ERR_NO_PORT = TIPC_ERR_NO_PORT,
+ /// Node doesn't exist.
+ ERR_NO_NODE = TIPC_ERR_NO_NODE,
+ /// Reception queue is full.
+ ERR_OVERLOAD = TIPC_ERR_OVERLOAD,
+ /// Connection shutted down.
+ CONN_SHUTDOWN = TIPC_CONN_SHUTDOWN
+};
+
+/**
+ * Subscription filter type.
+ *
+ * @see TIPC documentation: 1.4.3 Name Subscriptions
+ */
+enum subcription_t
+{
+ /**
+ * Causes the topology service to generate a event::PUBLISHED event
+ * for each port name or port name sequence it finds that overlaps
+ * the specified port name sequence; a TIPC_WITHDRAWN event is issued
+ * each time a previously reported name becomes unavailable.
+ *
+ * Allows the topology service to inform the application if there
+ * are @b any ports of interest.
+ */
+ SUB_PORTS = TIPC_SUB_PORTS,
+ /**
+ * Causes the topology service to generate a single publish event for
+ * the first port it finds with an overlapping name and a single
+ * withdraw event when the last such port becomes unavailable.
+ *
+ * Allows the topology service to inform the application about
+ * @b all ports of interest.
+ */
+ SUB_SERVICE = TIPC_SUB_SERVICE
+};
+
+/**
+ * Subscription request message.
+ *
+ * @see TIPC documentation: 1.4.3 Name Subscriptions
+ */
+struct subscription: tipc_subscr
+{
+ /**
+ * Constructor.
+ *
+ * @param seq The port name sequence of interest to the application.
+ * @param timeout A subscription timeout value, in ms
+ * (or WAIT_FOREVER).
+ * @param filter An event filter specifying which events are of
+ * interest to the application (see subscription_t).
+ * @param usr_handle An 8 byte user handle that is application-defined.
+ */
+ subscription(nameseq seq, __u32 timeout, __u32 filter,
+ const char* usr_handle = "") throw ();
+};
+
+/**
+ * Event message.
+ *
+ * @see TIPC documentation: 1.4.3 Name Subscriptions
+ */
+struct event: tipc_event
+{
+ /// Type of events.
+ enum type_t
+ {
+ /// The port has been published.
+ PUBLISHED = TIPC_PUBLISHED,
+ /// The port has been withdrawn.
+ WITHDRAWN = TIPC_WITHDRAWN,
+ /// The event has timed out.
+ TIMEOUT = TIPC_SUBSCR_TIMEOUT
+ };
+};
+
+/**
+ * TIPC socket address (name).
+ *
+ * @see bind(2), Socket::bind()
+ * @see connect(2), Socket::connect()
+ * @see getsockaddr(2), Socket::getsockaddr()
+ * @see setsockaddr(2), Socket::setsockaddr()
+ * @see accept(2), Socket::accept()
+ * @see sendto(2), Socket::send()
+ * @see recvfrom(2), Socket::recv()
+ */
+struct sockaddr: sockaddr_tipc
+{
+
+ /// Type of TIPC address
+ enum type_t
+ {
+ ID = TIPC_ADDR_ID, ///< Port ID
+ NAME = TIPC_ADDR_NAME, ///< Port name
+ NAMESEQ = TIPC_ADDR_NAMESEQ, ///< Name sequence or multicast
+ };
+
+ /**
+ * Bind scope.
+ *
+ * @see TIPC documentation: 2.1.2 bind
+ */
+ enum scope_t
+ {
+ ZONE = TIPC_ZONE_SCOPE, ///< Zone scope.
+ CLUSTER = TIPC_CLUSTER_SCOPE, ///< Cluster scope.
+ NODE = TIPC_NODE_SCOPE ///< Node scope.
+ };
+
+ /// Constructor.
+ sockaddr() throw ();
+
+ /**
+ * Constructor using a port ID.
+ *
+ * @param port Port ID.
+ * @param scope Bind scope.
+ */
+ sockaddr(portid port, scope_t scope = ZONE) throw ();
+
+ /**
+ * Constructor using a port name.
+ *
+ * @param name Port name.
+ * @param scope Bind scope.
+ * @param domain Domain lookup.
+ *
+ * @see Documentación de TIPC: 1.4.1 Address Resolution
+ */
+ sockaddr(name name, scope_t scope = ZONE,
+ tipc::addr domain = tipc::addr(0u))
+ throw ();
+
+ /**
+ * Constructor using a port name sequence.
+ *
+ * @param nameseq Port name sequence.
+ * @param scope Bind scope.
+ */
+ sockaddr(nameseq nameseq, scope_t scope = ZONE) throw ();
+
+ /**
+ * Constructor using a multicast port name sequence.
+ *
+ * @param mcast Multicast port name sequence.
+ * @param scope Bind scope.
+ */
+ sockaddr(multicast mcast, scope_t scope = ZONE) throw ();
+
+ /// Type of TIPC address
+ type_t type() const throw ();
+
+ /// Length of this unix socket address
+ socklen_t length() const throw ();
+
+ /// Compare two TIPC socket addresses
+ bool operator == (const sockaddr& other) const throw ();
+
+};
+
+/// TIPC socket traits.
+struct traits
+{
+
+ /// Socket address type.
+ typedef tipc::sockaddr sockaddr;
+
+ /// Protocol family.
+ enum { PF = PF_TIPC };
+
+};
+
+/// TIPC socket
+typedef posixx::socket::basic_socket< traits > socket;
+
+} } } // namespace posixx::linux::tipc
+
+
+inline
+posixx::linux::tipc::addr::addr() throw (): address(0u)
+{
+}
+
+inline
+posixx::linux::tipc::addr::addr(__u32 address) throw (): address(address)
+{
+}
+
+inline
+posixx::linux::tipc::addr::addr(unsigned int zone, unsigned int cluster,
+ unsigned int node) throw ():
+ address(tipc_addr(zone, cluster, node))
+{
+}
+
+inline
+void posixx::linux::tipc::addr::zone(unsigned int zone) throw ()
+{
+ address = tipc_addr(zone, cluster(), node());
+}
+
+inline
+unsigned int posixx::linux::tipc::addr::zone() const throw ()
+{
+ return tipc_zone(address);
+}
+
+inline
+void posixx::linux::tipc::addr::cluster(unsigned int cluster) throw ()
+{
+ address = tipc_addr(zone(), cluster, node());
+}
+
+inline
+unsigned int posixx::linux::tipc::addr::cluster() const throw ()
+{
+ return tipc_cluster(address);
+}
+
+inline
+void posixx::linux::tipc::addr::node(unsigned int node) throw ()
+{
+ address = tipc_addr(zone(), cluster(), node);
+}
+
+inline
+unsigned int posixx::linux::tipc::addr::node() const throw ()
+{
+ return tipc_node(address);
+}
+
+inline
+posixx::linux::tipc::addr::operator __u32 () const throw ()
+{
+ return address;
+}
+
+inline
+posixx::linux::tipc::portid::portid(__u32 r, addr n) throw ()
+{
+ ref = r;
+ node = n;
+}
+
+inline
+posixx::linux::tipc::name::name(__u32 t, __u32 i) throw ()
+{
+ type = t;
+ instance = i;
+}
+
+inline
+posixx::linux::tipc::nameseq::nameseq(__u32 t, __u32 low, __u32 up) throw ()
+{
+ type = t;
+ lower = low;
+ upper = up;
+}
+
+inline
+posixx::linux::tipc::nameseq::nameseq(__u32 t, __u32 instance) throw ()
+{
+ type = t;
+ lower = instance;
+ upper = instance;
+}
+
+inline
+posixx::linux::tipc::multicast::multicast(__u32 t, __u32 low, __u32 up)
+ throw ()
+{
+ type = t;
+ lower = low;
+ upper = up;
+}
+
+inline
+posixx::linux::tipc::multicast::multicast(__u32 t, __u32 instance) throw ()
+{
+ type = t;
+ lower = instance;
+ upper = instance;
+}
+
+inline
+posixx::linux::tipc::subscription::subscription(nameseq s, __u32 t, __u32 f,
+ const char* uh) throw ()
+{
+ seq = s;
+ timeout = t;
+ filter = f;
+ std::memcpy(usr_handle, uh, sizeof(usr_handle));
+}
+
+inline
+posixx::linux::tipc::sockaddr::sockaddr() throw ()
+{
+}
+
+inline
+posixx::linux::tipc::sockaddr::sockaddr(portid port, scope_t s) throw ()
+{
+ family = AF_TIPC;
+ addrtype = TIPC_ADDR_ID;
+ scope = s;
+ addr.id = port;
+}
+
+inline
+posixx::linux::tipc::sockaddr::sockaddr(name name, scope_t s, tipc::addr d)
+ throw ()
+{
+ family = AF_TIPC;
+ addrtype = TIPC_ADDR_NAME;
+ scope = s;
+ addr.name.name = name;
+ addr.name.domain = d;
+}
+
+inline
+posixx::linux::tipc::sockaddr::sockaddr(nameseq nameseq, scope_t s) throw ()
+{
+ family = AF_TIPC;
+ addrtype = TIPC_ADDR_NAMESEQ;
+ scope = s;
+ addr.nameseq = nameseq;
+}
+
+inline
+posixx::linux::tipc::sockaddr::sockaddr(multicast mcast, scope_t s) throw ()
+{
+ family = AF_TIPC;
+ addrtype = TIPC_ADDR_MCAST;
+ scope = s;
+ addr.nameseq = mcast;
+}
+
+inline
+posixx::linux::tipc::sockaddr::type_t posixx::linux::tipc::sockaddr::type()
+ const throw ()
+{
+ return static_cast< type_t >(addrtype);
+}
+
+inline
+socklen_t posixx::linux::tipc::sockaddr::length() const throw ()
+{
+ return sizeof(sockaddr_tipc);
+}
+
+inline
+bool posixx::linux::tipc::sockaddr::operator == (const sockaddr& other) const
+ throw ()
+{
+ return !memcmp(this, &other, sizeof(*this));
+}
+
+#endif // POSIXX_LINUX_TIPC_HPP_
--- /dev/null
+#ifndef POSIXX_LINUX_TIPC_OPT_HPP_
+#define POSIXX_LINUX_TIPC_OPT_HPP_
+
+#include <linux/tipc.h>
+
+/// @file
+
+namespace posixx { namespace linux { namespace tipc {
+
+/**
+ * Specific options for TIPC sockets.
+ *
+ * @see tipc::socket::opt() and setsockopt(2) in TIPC documentation for more
+ * details.
+ */
+namespace opt {
+
+#define MKSOLOPT(O, T) \
+ struct O { \
+ enum { \
+ level = SOL_TIPC, \
+ optname = TIPC_ ## O, \
+ read = true, \
+ write = true }; \
+ typedef T type; }
+
+/**
+ * How to handle messages sent by the socket if link congestion occurs.
+ *
+ * If enabled, the message is discarded; otherwise the system queues the
+ * message for later transmission.
+ *
+ * By default, this option is disabled for socket::SEQPACKET, socket::STREAM,
+ * and socket::RDM socket types (resulting in "reliable" data transfer), and
+ * enabled for socket::DGRAM (resulting in "unreliable" data transfer).
+ */
+MKSOLOPT(SRC_DROPPABLE, int);
+
+/**
+ * How to handle messages sent by the socket if they cannot be delivered.
+ *
+ * This option governs the handling of messages sent by the socket if the
+ * message cannot be delivered to its destination, either because the receiver
+ * is congested or because the specified receiver does not exist. If enabled,
+ * the message is discarded; otherwise the message is returned to the sender.
+ *
+ * By default, this option is disabled for socket::SEQPACKET and socket::STREAM
+ * socket types, and enabled for socket::RDM and socket::DGRAM, This
+ * arrangement ensures proper teardown of failed connections when
+ * connection-oriented data transfer is used, without increasing the complexity
+ * of connectionless data transfer.
+ */
+MKSOLOPT(DEST_DROPPABLE, int);
+
+/**
+ * Number of ms connect() will wait before aborting a connection attempt.
+ *
+ * This option specifies the number of milliseconds socket::connect() will wait
+ * before aborting a connection attempt because the destination has not
+ * responded. By default, 8000 (i.e. 8 seconds) is used.
+ *
+ * This option has no effect when establishing connections using
+ * socket::sendto().
+ */
+MKSOLOPT(CONN_TIMEOUT, int);
+
+#undef MKSOLOPT
+
+/// @see IMPORTANCE
+enum importance
+{
+ LOW = TIPC_LOW_IMPORTANCE, ///< Low importance
+ MEDIUM = TIPC_MEDIUM_IMPORTANCE, ///< Medium importance
+ HIGH = TIPC_HIGH_IMPORTANCE, ///< High importance
+ CRITICAL = TIPC_CRITICAL_IMPORTANCE ///< Critical importance
+};
+
+/**
+ * How likely a message sent by the socket is to be affected by congestion.
+ *
+ * A message with higher importance is less likely to be delayed or dropped due
+ * to link congestion, and also less likely to be rejected due to receiver
+ * congestion. The following values are defined: ::LOW, ::MEDIUM, ::HIGH, and
+ * ::CRITICAL.
+ *
+ * By default, ::LOW is used for all TIPC socket types.
+ */
+struct IMPORTANCE
+{
+ typedef importance type;
+ enum
+ {
+ level = SOL_TIPC,
+ optname = TIPC_IMPORTANCE,
+ read = true,
+ write = true
+ };
+};
+
+} } } } // namespace posixx::linux::tipc::opt
+
+#endif // POSIXX_LINUX_TIPC_OPT_HPP_
--- /dev/null
+#ifndef POSIXX_SOCKET_INET_HPP_
+#define POSIXX_SOCKET_INET_HPP_
+
+#include "../basic_socket.hpp" // posixx::socket
+
+#include <netinet/in.h> // sockaddr_in, htonl, htons, {PF,AF}_INET, INADDR_ANY
+#include <arpa/inet.h> // inet_addr
+#include <cstring> // memset
+#include <string> // std::string
+
+/// @file
+
+namespace posixx { namespace socket {
+
+/// Internet Protocol sockets
+namespace inet {
+
+/// IP socket address
+struct sockaddr: sockaddr_in
+{
+
+ /**
+ * Create an IP socket address.
+ */
+ sockaddr(u_int16_t port = 0, const std::string& ip = "0.0.0.0")
+ throw ();
+
+ /// Length of this IP socket address
+ socklen_t length() const throw ();
+
+ /// Compare two IP socket addresses
+ bool operator == (const sockaddr& other) const throw ();
+
+ /// Get the port number
+ uint16_t port() const throw ();
+
+ /// Get the IP address
+ std::string addr() const throw ();
+
+}; // struct sockaddr
+
+/// IP socket traits
+struct traits
+{
+ /// Socket address type.
+ typedef inet::sockaddr sockaddr;
+ /// Protocol family.
+ enum { PF = PF_INET };
+};
+
+/// IP socket
+typedef posixx::socket::basic_socket< traits > socket;
+
+} } } // namespace posixx::socket::inet
+
+
+
+
+inline
+posixx::socket::inet::sockaddr::sockaddr(u_int16_t port, const std::string& ip)
+ throw ()
+{
+ memset(this, 0, sizeof(struct sockaddr_in));
+ sin_family = AF_INET;
+ if (ip == "0.0.0.0") {
+ sin_addr.s_addr = htonl(INADDR_ANY);
+ }
+ else {
+ sin_addr.s_addr = inet_addr(ip.c_str());
+ }
+ sin_port = htons(port);
+}
+
+inline
+socklen_t posixx::socket::inet::sockaddr::length() const throw ()
+{
+ return sizeof(sockaddr_in);
+}
+
+inline
+bool posixx::socket::inet::sockaddr::operator == (const sockaddr& other) const
+ throw ()
+{
+ return !memcmp(this, &other, sizeof(*this));
+}
+
+inline
+uint16_t posixx::socket::inet::sockaddr::port() const throw ()
+{
+ return ntohs(sin_port);
+}
+
+inline
+std::string posixx::socket::inet::sockaddr::addr() const throw ()
+{
+ return inet_ntoa(sin_addr);
+}
+
+#endif // POSIXX_SOCKET_INET_HPP_
--- /dev/null
+#ifndef POSIXX_SOCKET_OPT_HPP_
+#define POSIXX_SOCKET_OPT_HPP_
+
+#include <sys/socket.h>
+#include <linux/if.h> // TODO: split POSIX and Linux options
+
+/// @file
+
+namespace posixx { namespace socket {
+
+/**
+ * Type-safe socket options
+ *
+ * @see posixx::socket::setsockopt(), posixx::socket::getsockopt()
+ */
+namespace opt {
+
+#define MKSOLOPT(O, T, R, W) \
+ struct O { \
+ enum { \
+ level = SOL_SOCKET, \
+ optname = SO_ ## O, \
+ read = R, \
+ write = W }; \
+ typedef T; }
+#define MKSOLOPT_R(O, T) MKSOLOPT(O, T type, true, false)
+#define MKSOLOPT_RW(O, T) MKSOLOPT(O, T type, true, true)
+#define MKSOLOPT_ARRAY(O, T, S) MKSOLOPT(O, T type[S], true, true)
+
+MKSOLOPT_R(ACCEPTCONN, int);
+MKSOLOPT_ARRAY(BINDTODEVICE, char, IFNAMSIZ);
+MKSOLOPT_RW(BROADCAST, int);
+MKSOLOPT_RW(BSDCOMPAT, int);
+//XXX DEBUG is replaced by the preprocessor in debug builds MKSOLOPT_RW(DEBUG, int);
+MKSOLOPT_R(ERROR, int);
+MKSOLOPT_RW(DONTROUTE, int);
+MKSOLOPT_RW(KEEPALIVE, int);
+MKSOLOPT_RW(LINGER, linger);
+MKSOLOPT_RW(OOBINLINE, int);
+MKSOLOPT_RW(PASSCRED, int);
+MKSOLOPT_R(PEERCRED, ucred);
+MKSOLOPT_RW(PRIORITY, int);
+MKSOLOPT_RW(RCVBUF, size_t);
+MKSOLOPT_RW(RCVBUFFORCE, size_t);
+MKSOLOPT_RW(RCVLOWAT, size_t);
+MKSOLOPT_R(SNDLOWAT, size_t);
+MKSOLOPT_RW(RCVTIMEO, timeval);
+MKSOLOPT_RW(SNDTIMEO, timeval);
+MKSOLOPT_RW(REUSEADDR, int);
+MKSOLOPT_RW(SNDBUF, size_t);
+MKSOLOPT_RW(SNDBUFFORCE, size_t);
+MKSOLOPT_RW(TIMESTAMP, int);
+MKSOLOPT_R(TYPE, int);
+
+#undef MKSOLOPT
+#undef MKSOLOPT_R
+#undef MKSOLOPT_RW
+#undef MKSOLOPT_ARRAY
+
+} } } // namespace posixx::socket::opt
+
+#endif // POSIXX_SOCKET_OPT_HPP_
--- /dev/null
+#ifndef POSIXX_SOCKET_UNIX_HPP_
+#define POSIXX_SOCKET_UNIX_HPP_
+
+#include "../basic_socket.hpp" // posixx::socket
+
+#include <sys/un.h> // sockaddr_un
+#include <string> // std::string
+#include <utility> // std::pair
+#include <cstring> // memset, memcpy, memcmp
+
+/// @file
+
+namespace posixx { namespace socket {
+
+/// Unix (local) sockets
+namespace unix {
+
+/// Unix socket address
+struct sockaddr: sockaddr_un
+{
+
+ /// Create an empty unix socket address.
+ sockaddr() throw ();
+
+ /**
+ * Create a unix socket address.
+ *
+ * @param path Path to the socket (should be less than ::PATH_MAX
+ * characters long).
+ */
+ sockaddr(const std::string& path) throw (std::logic_error);
+
+ /// Length of this unix socket address
+ socklen_t length() const throw ();
+
+ /// Get the path of this unix socket address
+ std::string path() const throw ();
+
+ /// Compare two unix socket addresses
+ bool operator == (const sockaddr& other) const throw ();
+
+}; // struct sockaddr
+
+/// Unix socket traits
+struct traits
+{
+ /// Socket address type.
+ typedef posixx::socket::unix::sockaddr sockaddr;
+ /// Protocol family.
+ enum { PF = PF_UNIX };
+};
+
+/// Unix socket
+typedef posixx::socket::basic_socket< traits > socket;
+
+/// Pair of unix sockets
+typedef std::pair< socket*, socket* > pair_type;
+
+/// Create a pair of connected unix sockets
+pair_type pair(type type, int protocol = 0) throw (posixx::error);
+
+} } } // namespace posixx::socket::unix
+
+
+
+inline
+posixx::socket::unix::sockaddr::sockaddr() throw ()
+{
+ sun_family = AF_UNIX;
+}
+
+inline
+posixx::socket::unix::sockaddr::sockaddr(const std::string& path)
+ throw (std::logic_error)
+{
+ if (path.size() >= sizeof(sun_path))
+ throw std::logic_error("path too long");
+ sun_family = AF_UNIX;
+ memcpy(sun_path, path.c_str(), path.size() + 1); // \0
+}
+
+inline
+socklen_t posixx::socket::unix::sockaddr::length() const throw ()
+{
+ return sizeof(sun_family) + strlen(sun_path);
+}
+
+inline
+std::string posixx::socket::unix::sockaddr::path() const throw ()
+{
+ return std::string(sun_path);
+}
+
+inline
+bool posixx::socket::unix::sockaddr::operator == (const sockaddr& other)
+ const throw ()
+{
+ return sun_family == other.sun_family
+ && !strncmp(sun_path, other.sun_path, sizeof(sun_path));
+}
+
+inline
+posixx::socket::unix::pair_type posixx::socket::unix::pair(type type,
+ int protocol) throw (posixx::error)
+{
+ return posixx::socket::pair< socket >(type, protocol);
+}
+
+#endif // POSIXX_SOCKET_UNIX_HPP_
--- /dev/null
+#ifndef POSIXX_STATIC_ASSERT_HPP_
+#define POSIXX_STATIC_ASSERT_HPP_
+
+template <bool x> struct POSIXX_STATIC_ASSERTION_FAILURE;
+template <> struct POSIXX_STATIC_ASSERTION_FAILURE<true> { enum {value = 1}; };
+#define static_assert( B, M ) \
+ enum { static_assert_enum_ ## __LINE__ \
+ = sizeof(POSIXX_STATIC_ASSERTION_FAILURE< (bool)( B ) >) }
+
+#endif // POSIXX_STATIC_ASSERT_HPP_
--- /dev/null
+
+CINCPATH = -isystem include
+CFLAGS += -std=c++98 -Wall -pedantic
+LDFLAGS = -lboost_unit_test_framework
+
+TESTPRG = test_suite
+TESTCMD = ./$(TESTPRG) --detect_memory_leak=1 --report_level=short \
+# --build_info=yes --log_level=test_suite \
+# | grep -v "Entering test case " | grep -v "Leaving test case"
+
+VALGRIND = valgrind --tool=memcheck --leak-check=yes --db-attach=no \
+ --num-callers=24 --leak-resolution=high --track-fds=yes \
+ --suppressions=valgrind.suppressions
+
+
+SOURCES = $(shell find -name '*.cpp')
+OBJS = $(SOURCES:.cpp=.o)
+
+
+
+ALL_CFLAGS = $(CFLAGS) $(CINCPATH)
+
+ifdef RELEASE
+ALL_CFLAGS += -O3 -NDEBUG
+endif
+
+ifdef DEBUG
+ALL_CFLAGS += -g -DDEBUG
+endif
+
+ifdef PROFILE
+ALL_CFLAGS += -g -pg -fprofile-arcs -ftest-coverage
+endif
+
+
+ifneq ($(V), 1)
+NICE_CXX = @echo " CXX $@"; $(CXX)
+NICE_LINK = @echo " LINK $@"; $(CXX)
+NICE_TEST = @echo " TEST"; $(TESTCMD) > /dev/null 2>&1
+NICE_MEMTEST = @echo " MEMTEST"; $(VALGRIND) --log-file=valgrind.log \
+ $(TESTCMD) > /dev/null 2>&1
+NICE_CLEAN = @echo " CLEAN"; $(RM)
+else
+NICE_CXX = $(CXX)
+NICE_LINK = $(CXX)
+NICE_TEST = $(TESTCMD)
+NICE_MEMTEST = $(VALGRIND) $(TESTCMD)
+NICE_CLEAN = $(RM) -v
+endif
+
+
+default: all
+
+all: test_suite
+
+
+# dependency handling
+
+# XXX the mkdir *has* to be inside the rule, otherwise make will build the
+# dependencies over and over again, because of this:
+# When a file that is included in the Makefile need to be built by itself,
+# the Makefile is re-executed after building the files to include. The
+# problem is, the directory .deps is updated *after* the files are created
+# in it, so when the Makefile re-executes, the files to include are created
+# but one of it's dependencies (the .deps directory) is outdated, so the
+# the files to include are re-built and the Makefile re-executed again,
+# entering in an infinite loop.
+.deps/%.deps: %.cpp
+ @mkdir -p $(dir $@)
+ @set -e; rm -f $@; \
+ $(CC) -MM -MG -MP $(CPPFLAGS) $(ALL_CFLAGS) $< -MF $@.$$$$; \
+ sed 's,\($(notdir $*)\)\.o[ :]*,$(dir $<)\1.o $@ : ,g' < $@.$$$$ > $@; \
+ rm -f $@.$$$$
+
+ifneq ($(MAKECMDGOALS),clean)
+-include $(addprefix .deps/,$(OBJS:.o=.deps))
+endif
+
+
+# main build
+
+
+$(TESTPRG): $(OBJS)
+ $(NICE_LINK) $(ALL_CFLAGS) $(LDFLAGS) -o $@ $^
+
+$(OBJS): include
+
+.cpp.o:
+ $(NICE_CXX) $(ALL_CFLAGS) -c $< -o $@
+
+include:
+ @mkdir -p include
+ @ln -fs ../../src include/posixx
+
+test: all
+ $(NICE_TEST)
+
+memtest: all
+ $(NICE_MEMTEST)
+
+clean:
+ $(NICE_CLEAN) -r $(TESTPRG) include $(OBJS) .deps valgrind.log \
+ *.bb *.bbg *.da *.gcov *.gcda *.gcno gmon.out
+
+.PHONY: default all test clean
+
+
--- /dev/null
+
+#include <posixx/error.hpp> // posixx::error
+
+#include <boost/test/unit_test.hpp>
+#include <string>
+#include <unistd.h>
+
+BOOST_AUTO_TEST_SUITE( error_suite )
+
+BOOST_AUTO_TEST_CASE( constructor_test )
+{
+
+ // default constructor
+ close(-123);
+ posixx::error e1;
+ BOOST_CHECK_EQUAL(e1.no, EBADF);
+
+ // "where" string constructor
+ close(-123);
+ posixx::error e2("fopen");
+ BOOST_CHECK_EQUAL(e2.no, EBADF);
+ BOOST_CHECK_EQUAL(std::string(e2.what()).find("fopen: "), 0);
+
+ // e1 and e2 should be the same appart from the "where" string
+ BOOST_CHECK_EQUAL(std::string(e2.what()).substr(7), e1.what());
+
+}
+
+BOOST_AUTO_TEST_SUITE_END()
+
--- /dev/null
+#ifndef TEST_LINUX_TIPC_COMMON_HPP_
+#define TEST_LINUX_TIPC_COMMON_HPP_
+
+#include <posixx/linux/tipc.hpp> // posixx::linux::tipc
+#include <ostream> // std::ostream
+
+#define PTYPE 10000
+#define INST1 10001
+#define INST2 10002
+
+static inline
+std::ostream& operator << (std::ostream& os,
+ const posixx::linux::tipc::sockaddr& sa) throw()
+{
+ using posixx::linux::tipc::sockaddr;
+ os << "tipc::sockaddr(scope=" << unsigned(sa.scope) << ", ";
+ switch (sa.type())
+ {
+ case sockaddr::ID:
+ os << "id(ref=" << sa.addr.id.ref
+ << ", node=" << sa.addr.id.node << ")";
+ break;
+ case sockaddr::NAME:
+ os << "name(type=" << sa.addr.name.name.type
+ << ", instance=" << sa.addr.name.name.instance
+ << ", domain=" << sa.addr.name.domain << ")";
+ break;
+ case sockaddr::NAMESEQ:
+ os << "nameseq(type=" << sa.addr.nameseq.type
+ << ", lower=" << sa.addr.nameseq.lower
+ << ", upper=" << sa.addr.nameseq.upper << ")";
+ break;
+ default:
+ os << "UNKNOWN!";
+ }
+ return os << ")";
+}
+
+// no need to clean addresses
+#define clean_test_address(socket, addr)
+
+static posixx::linux::tipc::sockaddr test_address1(
+ posixx::linux::tipc::name(PTYPE, INST1));
+static posixx::linux::tipc::sockaddr test_address2(
+ posixx::linux::tipc::name(PTYPE, INST2));
+
+#endif // TEST_LINUX_TIPC_COMMON_HPP_
--- /dev/null
+
+#include "common.hpp" // test_address1, test_address2 (for the generic test)
+#include <boost/test/unit_test.hpp> // unit testing stuff
+#include "../../socket/generic_test_includes.hpp" // (for the generic test)
+
+BOOST_AUTO_TEST_SUITE( linux_tipc_dgram_suite )
+
+#define TEST_DGRAM
+#define TEST_NS ::posixx::linux::tipc
+#define TEST_PF_TIPC
+#define TEST_PROTOCOL 0
+#include "../../socket/generic_test.hpp"
+
+BOOST_AUTO_TEST_SUITE_END()
+
--- /dev/null
+
+#include "common.hpp" // test_address1, test_address2 (for the generic test)
+#include <boost/test/unit_test.hpp> // unit testing stuff
+#include "../../socket/generic_test_includes.hpp" // (for the generic test)
+
+BOOST_AUTO_TEST_SUITE( linux_tipc_rdm_suite )
+
+#define TEST_RDM
+#define TEST_NS ::posixx::linux::tipc
+#define TEST_PF_TIPC
+#define TEST_PROTOCOL 0
+#include "../../socket/generic_test.hpp"
+
+BOOST_AUTO_TEST_SUITE_END()
+
--- /dev/null
+
+#include "common.hpp" // test_address1, test_address2 (for the generic test)
+#include <boost/test/unit_test.hpp> // unit testing stuff
+#include "../../socket/generic_test_includes.hpp" // (for the generic test)
+
+BOOST_AUTO_TEST_SUITE( linux_tipc_seqpacket_suite )
+
+#define TEST_SEQPACKET
+#define TEST_NS ::posixx::linux::tipc
+#define TEST_PF_TIPC
+#define TEST_PROTOCOL 0
+#include "../../socket/generic_test.hpp"
+
+BOOST_AUTO_TEST_SUITE_END()
+
--- /dev/null
+
+#include "common.hpp" // PTYPE, INST{1,2}, test_address{1,2}
+#include <posixx/linux/tipc.hpp> // posixx::linux::tipc
+#include <boost/test/unit_test.hpp> // unit testing stuff
+
+BOOST_AUTO_TEST_CASE( linux_tipc_sockaddr_test )
+{
+ BOOST_CHECK_EQUAL(test_address1.addr.name.name.type, PTYPE);
+ BOOST_CHECK_EQUAL(test_address1.addr.name.name.instance, INST1);
+ BOOST_CHECK_EQUAL(test_address2.addr.name.name.type, PTYPE);
+ BOOST_CHECK_EQUAL(test_address2.addr.name.name.instance, INST2);
+}
+
--- /dev/null
+
+#include "common.hpp" // test_address1, test_address2 (for the generic test)
+#include <boost/test/unit_test.hpp> // unit testing stuff
+#include "../../socket/generic_test_includes.hpp" // (for the generic test)
+
+BOOST_AUTO_TEST_SUITE( linux_tipc_stream_suite )
+
+#define TEST_STREAM
+#define TEST_NS ::posixx::linux::tipc
+#define TEST_PF_TIPC
+#define TEST_PROTOCOL 0
+#include "../../socket/generic_test.hpp"
+
+BOOST_AUTO_TEST_SUITE_END()
+
--- /dev/null
+
+/*
+ * This file should be included from others, and the next symbols are expected
+ * to be defined:
+ *
+ * Preprocessor constants:
+ * - One of TEST_[socket type]
+ * - TEST_NS should be set to the namespace the socket family that will be used
+ * - TEST_PROTOCOL should be set to the socket's protocol to be tested
+ * - TEST_HAVE_PAIR should be defined if the socket family have a "pair()"
+ * function.
+ * - TEST_CHECK_ADDR should be defined if name() should return the same
+ * sockaddr used when bind()ing.
+ *
+ * Global variables:
+ * - test_address1 and test_address2 should be valid sockaddrs.
+ *
+ * Global functions:
+ * - void clean_test_address(TEST_NS::sock& socket, const TEST_NS::sockaddr&)
+ * should be a function. It will be called before binding a socket to do any
+ * cleanup task for a particular address to be used. Can be a macro.
+ * - std::ostream& operator << (std::ostream& os, const TEST_NS::sockaddr&)
+ * should be defined.
+ */
+
+
+#ifdef TEST_PF_UNIX
+#undef TEST_PF_UNIX
+#define TEST_PF_UNIX 1
+#else
+#define TEST_PF_UNIX 0
+#endif
+#ifdef TEST_PF_INET
+#undef TEST_PF_INET
+#define TEST_PF_INET 1
+#else
+#define TEST_PF_INET 0
+#endif
+#ifdef TEST_PF_TIPC
+#undef TEST_PF_TIPC
+#define TEST_PF_TIPC 1
+#else
+#define TEST_PF_TIPC 0
+#endif
+
+#ifdef TEST_DGRAM
+#undef TEST_DGRAM
+#define TEST_DGRAM 1
+#else
+#define TEST_DGRAM 0
+#endif
+#ifdef TEST_RDM
+#undef TEST_RDM
+#define TEST_RDM 1
+#else
+#define TEST_RDM 0
+#endif
+#ifdef TEST_STREAM
+#undef TEST_STREAM
+#define TEST_STREAM 1
+#else
+#define TEST_STREAM 0
+#endif
+#ifdef TEST_SEQPACKET
+#undef TEST_SEQPACKET
+#define TEST_SEQPACKET 1
+#else
+#define TEST_SEQPACKET 0
+#endif
+#ifdef TEST_RAW
+#undef TEST_RAW
+#define TEST_RAW 1
+#else
+#define TEST_RAW 0
+#endif
+
+#if TEST_DGRAM
+#define TEST_TYPE ::posixx::socket::DGRAM
+#endif
+#if TEST_RDM
+#define TEST_TYPE ::posixx::socket::RDM
+#endif
+#if TEST_STREAM
+#define TEST_TYPE ::posixx::socket::STREAM
+#endif
+#if TEST_SEQPACKET
+#define TEST_TYPE ::posixx::socket::SEQPACKET
+#endif
+#if TEST_RAW
+#define TEST_TYPE ::posixx::socket::RAW
+#endif
+
+
+#if TEST_PF_UNIX // unix sockets are the only that provides pairs
+
+BOOST_AUTO_TEST_CASE( pair_test )
+{
+ TEST_NS::pair_type p = TEST_NS::pair(TEST_TYPE, TEST_PROTOCOL);
+ BOOST_CHECK_GE( p.first->fd(), 0 );
+ BOOST_CHECK_GE( p.second->fd(), 0 );
+ delete p.first;
+ delete p.second;
+}
+
+#endif // TEST_PF_UNIX
+
+BOOST_AUTO_TEST_CASE( constructor_test )
+{
+ TEST_NS::socket s(TEST_TYPE, TEST_PROTOCOL);
+ BOOST_CHECK_GE( s.fd(), 0 );
+}
+
+BOOST_AUTO_TEST_CASE( close_test )
+{
+ TEST_NS::socket s(TEST_TYPE, TEST_PROTOCOL);
+ s.close();
+ BOOST_CHECK_EQUAL( s.fd(), -1 );
+}
+
+BOOST_AUTO_TEST_CASE( options_test )
+{
+ using ::posixx::socket::opt::REUSEADDR;
+ TEST_NS::socket s(TEST_TYPE, TEST_PROTOCOL);
+ s.opt< REUSEADDR >(true);
+ BOOST_CHECK_GE( s.opt< REUSEADDR >(), true );
+}
+
+BOOST_AUTO_TEST_CASE( bind_test )
+{
+ TEST_NS::socket s(TEST_TYPE, TEST_PROTOCOL);
+ clean_test_address(s, test_address1);
+ s.bind(test_address1);
+ s.name();
+#if !TEST_PF_TIPC // TIPC returns a Port ID (and we use Port names)
+ BOOST_CHECK_EQUAL( s.name(), test_address1 );
+#endif
+}
+
+
+#if TEST_SEQPACKET || TEST_STREAM
+
+// TODO: test different flavors of send/recv.
+
+BOOST_AUTO_TEST_CASE( listen_test )
+{
+ TEST_NS::socket s(TEST_TYPE, TEST_PROTOCOL);
+ clean_test_address(s, test_address1);
+ s.bind(test_address1);
+ s.listen();
+}
+
+static inline
+void set_blocking(int fd, bool blocking)
+{
+ int flags = fcntl(fd, F_GETFL, 0);
+ assert(flags != -1);
+ if (blocking)
+ fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
+ else
+ fcntl(fd, F_SETFL, flags | O_NONBLOCK);
+}
+
+#if !TEST_PF_TIPC // TIPC can't connect a non-blocking socket
+BOOST_AUTO_TEST_CASE( connect_accept_test )
+{
+ TEST_NS::socket ss(TEST_TYPE, TEST_PROTOCOL);
+ clean_test_address(ss, test_address1);
+ ss.bind(test_address1);
+ ss.listen();
+ TEST_NS::socket sc(TEST_TYPE, TEST_PROTOCOL);
+ set_blocking(sc, false);
+ try {
+ sc.connect(test_address1);
+ } catch (const posixx::error& e) {
+ BOOST_REQUIRE_EQUAL( e.no, EINPROGRESS );
+ }
+ set_blocking(sc, true);
+ TEST_NS::socket* sa = ss.accept();
+ BOOST_CHECK_EQUAL( sc.peer_name(), test_address1 );
+ BOOST_CHECK_EQUAL( sc.peer_name(), sa->name() );
+#if !TEST_PF_UNIX // Unix sockets has garbage in this addresses
+ BOOST_CHECK_EQUAL( sc.name(), sa->peer_name() );
+#endif // TEST_PF_UNIX
+ delete sa;
+}
+#endif // !TEST_PF_TIPC
+
+#endif // TEST_SEQPACKET || TEST_STREAM
+
+
+#if TEST_DGRAM || TEST_RDM || TEST_RAW
+
+BOOST_AUTO_TEST_CASE( dgram_sendto_recvfrom_test )
+{
+ // socket 1
+ TEST_NS::socket s1(TEST_TYPE, TEST_PROTOCOL);
+ clean_test_address(s1, test_address1);
+ s1.bind(test_address1);
+ // socket 2
+ TEST_NS::socket s2(TEST_TYPE, TEST_PROTOCOL);
+ clean_test_address(s2, test_address2);
+ s2.bind(test_address2);
+ // socket 1 send
+ char buffer[] = "hello world!";
+ BOOST_CHECK_EQUAL( s1.send(buffer, sizeof(buffer), test_address2),
+ sizeof(buffer) );
+ memset(buffer, 0, sizeof(buffer));
+ // socket 2 receive
+ TEST_NS::sockaddr addr;
+ BOOST_CHECK_EQUAL( s2.recv(buffer, sizeof(buffer), addr),
+ sizeof(buffer) );
+ BOOST_CHECK_EQUAL( buffer, "hello world!" );
+#if !TEST_PF_TIPC // TIPC returns a Port ID (and we use Port names)
+ BOOST_CHECK_EQUAL( addr, test_address1 );
+#endif
+}
+
+struct data
+{
+ char msg[20];
+ int number;
+};
+
+BOOST_AUTO_TEST_CASE( dgram_sendto_recvfrom_struct_test )
+{
+ // socket 1
+ TEST_NS::socket s1(TEST_TYPE, TEST_PROTOCOL);
+ clean_test_address(s1, test_address1);
+ s1.bind(test_address1);
+ // socket 2
+ TEST_NS::socket s2(TEST_TYPE, TEST_PROTOCOL);
+ clean_test_address(s2, test_address2);
+ s2.bind(test_address2);
+ // socket 1 send
+ data d;
+ strcpy(d.msg, "hello world!");
+ d.number = -32495813;
+ s1.send_struct(d, test_address2);
+ memset(&d, 0, sizeof(data));
+ // socket 2 receive
+ TEST_NS::sockaddr addr;
+ s2.recv_struct(d, addr);
+ BOOST_CHECK_EQUAL( d.msg, "hello world!" );
+ BOOST_CHECK_EQUAL( d.number, -32495813 );
+}
+
+#endif // TEST_DGRAM || TEST_RDM || TEST_RAW
+
--- /dev/null
+/*
+ * This file should be included before using generic_test.hpp, outside any
+ * BOOST_... suite or unit test.
+ */
+
+#include <unistd.h>
+#include <fcntl.h>
+#include <cstring>
+#include <string>
+#include <posixx/basic_socket.hpp>
+#include <posixx/socket/opt.hpp>
+
--- /dev/null
+#ifndef TEST_SOCKET_IP_COMMON_HPP_
+#define TEST_SOCKET_IP_COMMON_HPP_
+
+#include <posixx/socket/inet.hpp> // posixx::socket::inet
+#include <posixx/socket/opt.hpp> // posixx::socket::opt::REUSEADDR
+#include <ostream> // std::ostream
+
+#define IP "127.0.0.1"
+#define PORT1 10001
+#define PORT2 10002
+
+static inline
+std::ostream& operator << (std::ostream& os,
+ const posixx::socket::inet::sockaddr& sa) throw()
+{
+ return os << "inet::sockaddr(family=" << sa.sin_family
+ << ", port=" << ntohs(sa.sin_port)
+ << ", addr=" << inet_ntoa(sa.sin_addr) << ")";
+}
+
+static inline
+void clean_test_address(posixx::socket::inet::socket& socket,
+ const posixx::socket::inet::sockaddr& addr)
+{
+ // reuse the socket address (just in case)
+ socket.opt< posixx::socket::opt::REUSEADDR >(true);
+}
+
+static posixx::socket::inet::sockaddr test_address1(PORT1, IP);
+static posixx::socket::inet::sockaddr test_address2(PORT2, IP);
+
+#endif // TEST_SOCKET_IP_COMMON_HPP_
--- /dev/null
+
+#include "common.hpp" // test_address1, test_address2 (for the generic test)
+#include <boost/test/unit_test.hpp> // unit testing stuff
+#include "../../socket/generic_test_includes.hpp" // (for the generic test)
+
+BOOST_AUTO_TEST_SUITE( socket_inet_dgram_suite )
+
+#define TEST_DGRAM
+#define TEST_NS ::posixx::socket::inet
+#define TEST_PF_INET
+#define TEST_PROTOCOL 0
+#define TEST_CHECK_ADDR
+#include "../generic_test.hpp"
+
+BOOST_AUTO_TEST_SUITE_END()
+
--- /dev/null
+
+#include "common.hpp" // IP, PORT{1,2}, test_address{1,2}
+#include <posixx/socket/inet.hpp> // posixx::socket::inet
+#include <boost/test/unit_test.hpp> // unit testing stuff
+
+BOOST_AUTO_TEST_CASE( socket_inet_sockaddr_test )
+{
+ BOOST_CHECK_EQUAL(test_address1.addr(), IP);
+ BOOST_CHECK_EQUAL(test_address1.port(), PORT1);
+}
+
--- /dev/null
+
+#include "common.hpp" // test_address1, test_address2 (for the generic test)
+#include <boost/test/unit_test.hpp> // unit testing stuff
+#include "../../socket/generic_test_includes.hpp" // (for the generic test)
+
+BOOST_AUTO_TEST_SUITE( socket_inet_stream_suite )
+
+#define TEST_STREAM
+#define TEST_NS ::posixx::socket::inet
+#define TEST_PF_INET
+#define TEST_PROTOCOL 0
+#define TEST_CHECK_ADDR
+#include "../generic_test.hpp"
+
+BOOST_AUTO_TEST_SUITE_END()
+
--- /dev/null
+#ifndef TEST_SOCKET_UNIX_COMMON_HPP_
+#define TEST_SOCKET_UNIX_COMMON_HPP_
+
+#include <posixx/socket/unix.hpp> // posixx::socket::unix
+#include <boost/test/unit_test.hpp> // unit testing stuff
+#include <ostream> // std::ostream
+#include <unistd.h> // unlink
+#include <sys/stat.h> // struct stat
+
+#define PATH "/tmp/posixx_socket_unix_test"
+#define PATH1 PATH "1"
+#define PATH2 PATH "2"
+
+static inline
+std::ostream& operator << (std::ostream& os,
+ const posixx::socket::unix::sockaddr& sa) throw()
+{
+ return os << "unix::sockaddr(family=" << sa.sun_family
+ << ", path=" << sa.sun_path << ")";
+}
+
+static inline
+void clean_test_address(posixx::socket::unix::socket& socket,
+ const posixx::socket::unix::sockaddr& addr)
+{
+ // remove the socket file, if exists
+ struct stat st;
+ if (stat(addr.sun_path, &st) == 0)
+ BOOST_REQUIRE_EQUAL(unlink(addr.sun_path), 0);
+}
+
+static posixx::socket::unix::sockaddr test_address1(PATH1);
+static posixx::socket::unix::sockaddr test_address2(PATH2);
+
+#endif // TEST_SOCKET_UNIX_COMMON_HPP_
--- /dev/null
+
+#include "common.hpp" // test_address1, test_address2
+#include <posixx/socket/unix.hpp> // posixx::socket::unix
+#include <boost/test/unit_test.hpp> // unit testing stuff
+#include "../../socket/generic_test_includes.hpp" // (for the generic test)
+
+BOOST_AUTO_TEST_SUITE( socket_unix_dgram_suite )
+
+#define TEST_DGRAM
+#define TEST_NS ::posixx::socket::unix
+#define TEST_PF_UNIX
+#define TEST_PROTOCOL 0
+#define TEST_HAVE_PAIR
+#define TEST_CHECK_ADDR
+#include "../generic_test.hpp"
+
+BOOST_AUTO_TEST_SUITE_END()
+
--- /dev/null
+
+#include "common.hpp" // PATH{1,2}, test_address{1,2}
+#include <boost/test/unit_test.hpp> // unit testing stuff
+
+BOOST_AUTO_TEST_CASE( socket_unix_sockaddr_test )
+{
+ BOOST_CHECK_EQUAL(test_address1.path(), PATH1);
+ BOOST_CHECK_EQUAL(test_address2.path(), PATH2);
+}
+
--- /dev/null
+
+#include "common.hpp" // test_address1, test_address2
+#include <posixx/socket/unix.hpp> // posixx::socket::unix
+#include <boost/test/unit_test.hpp> // unit testing stuff
+#include "../../socket/generic_test_includes.hpp" // (for the generic test)
+
+BOOST_AUTO_TEST_SUITE( socket_unix_stream_suite )
+
+#define TEST_STREAM
+#define TEST_NS ::posixx::socket::unix
+#define TEST_PF_UNIX
+#define TEST_PROTOCOL 0
+#define TEST_HAVE_PAIR
+#define TEST_CHECK_ADDR
+#include "../generic_test.hpp"
+
+BOOST_AUTO_TEST_SUITE_END()
+
--- /dev/null
+
+#define BOOST_TEST_MAIN
+#define BOOST_TEST_DYN_LINK
+#define BOOST_TEST_MODULE posixx
+#include <boost/test/unit_test.hpp>
+
--- /dev/null
+
+# Suppressions for boost 1.35
+
+{
+ boost_test_1
+ Memcheck:Param
+ sigaltstack(ss)
+ obj:/lib/ld-2.7.so
+ fun:_ZN5boost17execution_monitor13catch_signalsERKNS_9unit_test9callback0IiEE
+ fun:_ZN5boost17execution_monitor7executeERKNS_9unit_test9callback0IiEE
+ fun:_ZN5boost9unit_test9framework4initEPFbvEiPPc
+ fun:_ZN5boost9unit_test14unit_test_mainEPFbvEiPPc
+ fun:main
+}
+{
+ boost_test_2
+ Memcheck:Param
+ sigaltstack(ss)
+ obj:/lib/ld-2.7.so
+ fun:_ZN5boost17execution_monitor13catch_signalsERKNS_9unit_test9callback0IiEE
+ fun:_ZN5boost17execution_monitor7executeERKNS_9unit_test9callback0IiEE
+ fun:_ZN5boost9unit_test9framework3runEmb
+ fun:_ZN5boost9unit_test14unit_test_mainEPFbvEiPPc
+ fun:main
+}
+{
+ boost_test_3
+ Memcheck:Param
+ sigaltstack(ss)
+ obj:/lib/ld-2.7.so
+ fun:_ZN5boost17execution_monitor13catch_signalsERKNS_9unit_test9callback0IiEE
+ fun:_ZN5boost17execution_monitor7executeERKNS_9unit_test9callback0IiEE
+ fun:_ZN5boost9unit_test19unit_test_monitor_t21execute_and_translateERKNS0_9test_caseE
+ fun:_ZN5boost9unit_test14framework_impl5visitERKNS0_9test_caseE
+ fun:_ZN5boost9unit_test18traverse_test_treeERKNS0_9test_caseERNS0_17test_tree_visitorE
+ fun:_ZN5boost9unit_test18traverse_test_treeEmRNS0_17test_tree_visitorE
+ fun:_ZN5boost9unit_test18traverse_test_treeERKNS0_10test_suiteERNS0_17test_tree_visitorE
+ fun:_ZN5boost9unit_test18traverse_test_treeEmRNS0_17test_tree_visitorE
+ fun:_ZN5boost9unit_test9framework3runEmb
+ fun:_ZN5boost9unit_test14unit_test_mainEPFbvEiPPc
+ fun:main
+}
+
projects / software / posixx.git / commitdiff