OnixS C++ FIX Engine  4.10.1
API Documentation
Definitions.h
Go to the documentation of this file.
1 #pragma once
2 /*
3 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
4 *
5 * This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
6 * and international copyright treaties.
7 *
8 * Access to and use of the software is governed by the terms of the applicable OnixS Software
9 * Services Agreement (the Agreement) and Customer end user license agreements granting
10 * a non-assignable, non-transferable and non-exclusive license to use the software
11 * for it's own data processing purposes under the terms defined in the Agreement.
12 *
13 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
14 * of this source code or associated reference material to any other location for further reproduction
15 * or redistribution, and any amendments to this copyright notice, are expressly prohibited.
16 *
17 * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
18 * the terms of the Agreement is a violation of copyright law.
19 */
20 
21 #if defined (_WIN32) // Windows platform.
22 
23 #if !defined (STRICT)
24 #define STRICT
25 #endif
26 
27 #include <Windows.h>
28 
29 #if defined (WIN32_LEAN_AND_MEAN)
30 #include <winsock2.h>
31 #endif
32 
33 #endif
34 
35 #include <vector>
36 
37 namespace OnixS {
38 namespace Sockets {
39 /// Type alias for byte.
40 typedef unsigned char Byte;
41 
42 /// Sequence of bytes.
43 typedef std::vector<Byte> Bytes;
44 
45 #if defined (_WIN32)
46 /// Type alias for socket handle
47 typedef SOCKET Handle;
48 #else
49 /// Type alias for socket handle
50 typedef int Handle;
51 #endif
52 
53 /// Socket option of the SOL_SOCKET level
54 struct SocketOption {
56  : optname(0), optval(), optlen(0) {}
57 
58  SocketOption(int optionName, void * optionValue, int optionLength)
59  : optname(optionName), optval(optionValue), optlen(optionLength) {}
60 
61  int optname;
62  const void * optval;
63  int optlen;
64 };
65 
66 /// Storage type of socket options
67 typedef std::vector<SocketOption> SocketOptions;
68 }
69 }
unsigned char Byte
Type alias for byte.
Definition: Definitions.h:40
int Handle
Type alias for socket handle.
Definition: Definitions.h:50
Socket option of the SOL_SOCKET level.
Definition: Definitions.h:54
std::vector< Byte > Bytes
Sequence of bytes.
Definition: Definitions.h:43
SocketOption(int optionName, void *optionValue, int optionLength)
Definition: Definitions.h:58
std::vector< SocketOption > SocketOptions
Storage type of socket options.
Definition: Definitions.h:67