ana/api/common.hpp File Reference

Main definitions for project ana. More...

#include <boost/asio/detail/socket_ops.hpp>
#include <boost/cstdint.hpp>
#include <boost/system/error_code.hpp>
#include "../../global.hpp"

Include dependency graph for common.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	ana
	Namespace for project ana, the entire API is under this namespce.
Type and constant definitions
Definitions of main types and relevant constants.
typedef boost::uint32_t	ana::ana_uint32
	Standard unsigned int, with fixed size to 32 bits.
typedef boost::int32_t	ana::ana_int32
	Standard int, with fixed size to 32 bits.
typedef boost::uint16_t	ana::ana_uint16
	Standard unsigned int, with fixed size to 16 bits.
typedef boost::int16_t	ana::ana_int16
	Standard int, with fixed size to 16 bits.
typedef ana_uint32	ana::message_size
	Message size type.
typedef size_t	ana::net_id
	IDs of connected components, unique, non zero.
typedef size_t	ana::operation_id
	IDs of network operations, unique, zero = no-op.
typedef std::string	ana::port
	Port type, a std::string (instead of a short.
typedef std::string	ana::address
	Address type, a string.
typedef bool	ana::send_type
	Send operation type, true to copy the buffer.
typedef boost::system::error_code	ana::error_code
	Standard error code, can evaluate to bool.
const ana::error_code	ana::operation_aborted
	The default timeout error.
const ana::error_code	ana::timeout_error
	The default timeout error.
const ana::error_code	ana::generic_error
	A generic error.
const operation_id	ana::no_operation = 0
	A network operation that didn't do anything.
const operation_id	ana::invalid_net_id = 0
	An invalid net_id.
const send_type	ana::ZERO_COPY = false
	Don't copy the buffer.
const send_type	ana::COPY_BUFFER = true
	Copy the buffer.
const message_size	ana::HEADER_LENGTH = sizeof(ana_uint32)
	Length of message header, 4 bytes.
const message_size	ana::INITIAL_RAW_MODE_BUFFER_SIZE = 256
	Initial length of raw message buffer.

---

Detailed Description

Main definitions for project ana.

ana: Asynchronous Network API. Copyright (C) 2010 - 2012 Guillermo Biset.

This file is part of the ana project.

System: ana Language: C++

Author: Guillermo Biset E-Mail: billybiset AT gmail DOT com

ana is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

ana is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with ana. If not, see <http://www.gnu.org/licenses/>.

Definition in file common.hpp.