Balau::Network Namespace Reference

Components and utilities working on network data transmission. More...

Namespaces
	Http
	Components and utilities working on HTTP data transmission.

Classes
class	MimeTypes
	Holds a map of mime types, keyed to the corresponding file extension. More...
struct	UrlDecode
	Utility for splitting and decoding URL encoded data. More...

Typedefs
using	Address = boost::asio::ip::address
	An IP4 or IP6 address. More...
using	BoostSystemError = boost::system::system_error
	Boost system error. More...
using	BoostSystemErrorCode = boost::system::error_code
	Boost system error codes. More...
using	Buffer = boost::beast::flat_buffer
	A data buffer used in HTTP code. More...
using	CharVectorBody = boost::beast::http::vector_body< char >
	A message body represented by a vector of 8 bit characters. More...
using	CharVectorRequest = Request< CharVectorBody >
	A request with a char vector body. More...
using	CharVectorResponse = Response< CharVectorBody >
	A response with a char vector body. More...
using	EmptyBody = boost::beast::http::empty_body
	A message body wth no content. More...
using	EmptyResponse = Response< EmptyBody >
	A response with an empty body. More...
using	Endpoint = boost::asio::ip::tcp::endpoint
	An IP address and port number. More...
using	Error = boost::beast::http::error
	Boost error codes returned from HTTP algorithms and operations. More...
using	Field = boost::beast::http::field
	An HTTP header field. More...
using	FileBody = Balau::Boost::Beast::Http::basic_file_body< boost::beast::file >
	A message body represented by a file on the filesystem. More...
using	FileBodyValue = FileBody::value_type
	The type of the message body represented by a file on the filesystem. More...
using	FileMode = boost::beast::file_mode
	Boost HTTP file open modes. More...
using	Method = boost::beast::http::verb
	The HTTP method (GET, HEAD, POST). More...
template<class Body , class Fields = boost::beast::http::fields>
using	Request = boost::beast::http::request< Body, Fields >
	The request type. More...
template<class Body , class Fields = boost::beast::http::fields>
using	Response = boost::beast::http::response< Body, Fields >
	The response type. More...
using	Status = boost::beast::http::status
	Boost status code. More...
using	StringBody = boost::beast::http::basic_string_body< char >
	A message body represented by a UTF-8 string. More...
using	StringRequest = Request< StringBody >
	A request with a string body. More...
using	StringResponse = Response< StringBody >
	A response with a string body. More...
using	TCP = boost::asio::ip::tcp
	The Boost SSL namespace. More...
using	WsFrame = WS::frame_type
	The Boost HTTP namespace. More...

Functions
Endpoint	makeEndpoint (const std::string &address, unsigned short port)
	Make an endpoint on the stack. More...
Endpoint	makeEndpoint (const char *address, unsigned short port)
	Make an endpoint on the stack. More...
std::shared_ptr< Endpoint >	newEndpoint (const std::string &address, unsigned short port)
	Make an endpoint on the heap. More...
std::shared_ptr< Endpoint >	newEndpoint (const char *address, unsigned short port)
	Make an endpoint on the heap. More...

Detailed Description

Components and utilities working on network data transmission.

Typedef Documentation

Address

using Address = boost::asio::ip::address

An IP4 or IP6 address.

BoostSystemError

using BoostSystemError = boost::system::system_error

Boost system error.

BoostSystemErrorCode

using BoostSystemErrorCode = boost::system::error_code

Boost system error codes.

Buffer

using Buffer = boost::beast::flat_buffer

A data buffer used in HTTP code.

CharVectorBody

using CharVectorBody = boost::beast::http::vector_body<char>

A message body represented by a vector of 8 bit characters.

CharVectorRequest

using CharVectorRequest = Request<CharVectorBody>

A request with a char vector body.

CharVectorResponse

using CharVectorResponse = Response<CharVectorBody>

A response with a char vector body.

EmptyBody

using EmptyBody = boost::beast::http::empty_body

A message body wth no content.

EmptyResponse

using EmptyResponse = Response<EmptyBody>

A response with an empty body.

Endpoint

using Endpoint = boost::asio::ip::tcp::endpoint

An IP address and port number.

Error

using Error = boost::beast::http::error

Boost error codes returned from HTTP algorithms and operations.

Field

using Field = boost::beast::http::field

An HTTP header field.

FileBody

using FileBody = Balau::Boost::Beast::Http::basic_file_body<boost::beast::file>

A message body represented by a file on the filesystem.

FileBodyValue

using FileBodyValue = FileBody::value_type

The type of the message body represented by a file on the filesystem.

FileMode

using FileMode = boost::beast::file_mode

Boost HTTP file open modes.

Method

using Method = boost::beast::http::verb

The HTTP method (GET, HEAD, POST).

Request

using Request = boost::beast::http::request<Body, Fields>

The request type.

Response

using Response = boost::beast::http::response<Body, Fields>

The response type.

Status

using Status = boost::beast::http::status

Boost status code.

StringBody

using StringBody = boost::beast::http::basic_string_body<char>

A message body represented by a UTF-8 string.

StringRequest

using StringRequest = Request<StringBody>

A request with a string body.

StringResponse

using StringResponse = Response<StringBody>

A response with a string body.

TCP

using TCP = boost::asio::ip::tcp

The Boost SSL namespace.

The Boost TCP namespace.

WsFrame

using WsFrame = WS::frame_type

The Boost HTTP namespace.

The Boost WebSocket namespace. WeSocket control frames.

Function Documentation

makeEndpoint() [1/2]

Endpoint Balau::Network::makeEndpoint ( const std::string &  address, unsigned short  port  )

inline

Make an endpoint on the stack.

makeEndpoint() [2/2]

Endpoint Balau::Network::makeEndpoint ( const char *  address, unsigned short  port  )

inline

Make an endpoint on the stack.

newEndpoint() [1/2]

std::shared_ptr<Endpoint> Balau::Network::newEndpoint ( const std::string &  address, unsigned short  port  )

inline

Make an endpoint on the heap.

newEndpoint() [2/2]

std::shared_ptr<Endpoint> Balau::Network::newEndpoint ( const char *  address, unsigned short  port  )

inline

Make an endpoint on the heap.