AMPS C/C++ Client Class Reference
AMPS C/C++ Client Version 5.3.3.0
amps_impl.h
1 /*//////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (c) 2010-2021 60East Technologies Inc., All Rights Reserved.
4 //
5 // This computer software is owned by 60East Technologies Inc. and is
6 // protected by U.S. copyright laws and other laws and by international
7 // treaties. This computer software is furnished by 60East Technologies
8 // Inc. pursuant to a written license agreement and may be used, copied,
9 // transmitted, and stored only in accordance with the terms of such
10 // license agreement and with the inclusion of the above copyright notice.
11 // This computer software or any other copies thereof may not be provided
12 // or otherwise made available to any other person.
13 //
14 // U.S. Government Restricted Rights. This computer software: (a) was
15 // developed at private expense and is in all respects the proprietary
16 // information of 60East Technologies Inc.; (b) was not developed with
17 // government funds; (c) is a trade secret of 60East Technologies Inc.
18 // for all purposes of the Freedom of Information Act; and (d) is a
19 // commercial item and thus, pursuant to Section 12.212 of the Federal
20 // Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202,
21 // Government's use, duplication or disclosure of the computer software
22 // is subject to the restrictions set forth by 60East Technologies Inc..
23 //
25 #ifndef _AMPS_IMPL_H_
26 #define _AMPS_IMPL_H_
27 #ifndef _WIN32
28 #define _GNU_SOURCE 1
29 #endif
30 #define _AMPS_BUILD_C_CLIENT 1
31 #include <amps.h>
32 #include <assert.h>
33 #include <stdlib.h>
34 
35 #define AMPSASSERT assert
36 #define AMPS_THREAD_START_TIMEOUT 120
37 
38 #ifdef _WIN32
39 
40 #include <Windows.h>
41 #define _AMPS_SNPRINTF(buf_, count_, ...) _snprintf_s(buf_, count_, _TRUNCATE, __VA_ARGS__)
42 #define _AMPS_KEYCREATE TlsAlloc
43 #define _AMPS_TLS_KEY DWORD
44 char* _amps_strndup(const char* ptr_, size_t len_);
45 #define _AMPS_STRNDUP _amps_strndup
46 
47 #else
48 #include <pthread.h>
49 #include <unistd.h>
50 #include <sys/socket.h>
51 #include <netinet/in.h>
52 #include <netinet/tcp.h>
53 #include <arpa/inet.h>
54 #include <malloc.h>
55 #define _AMPS_SNPRINTF snprintf
56 #define _AMPS_KEYCREATE pthread_key_create
57 #define _AMPS_TLS_KEY pthread_key_t
58 #define closesocket close
59 #define _AMPS_STRNDUP strndup
60 
61 
62 #ifndef SO_DOMAIN
63 #define AMPS_SO_DOMAIN 39
64 #else
65 #define AMPS_SO_DOMAIN (SO_DOMAIN)
66 #endif
67 
68 #endif
69 
70 #define AMPS_MIN(x,y) ((x)<(y)?(x):(y))
71 #define AMPS_MAX(x,y) ((x)>(y)?(x):(y))
72 
73 typedef enum
74 {
75  AMPS_PREFER_IPV4,
76  AMPS_PREFER_IPV6
77 }
78 amps_ip_protocol_preference;
79 #define AMPS_DEFAULT_IP_PROTOCOL_PREFERENCE AMPS_PREFER_IPV4
80 
81 typedef struct
82 {
83  char clientName[128];
84  size_t transportType;
85  amps_handle transport;
86  char lastError[1024];
87 
88  amps_predisconnect_handler predisconnectHandler;
89  void* predisconnectHandlerUserData;
90  amps_handler disconnectHandler;
91  void* disconnectHandlerUserData;
92 
93  amps_handler messageHandler;
94  void* messageHandlerUserData;
95 
96  amps_transport_filter_function transportFilterFunction;
97  void* transportFilterFunctionUserData;
98 
99  amps_thread_created_callback threadCreatedCallback;
100  void* threadCreatedCallbackUserData;
101 }
102 amps_client_t;
103 
104 typedef struct
105 {
106  char name[8];
107  amps_handle(*createFunc)(void);
108  amps_result(*connectFunc)(amps_handle, const amps_char*);
109  amps_result(*predisconnectFunc)(amps_handle, amps_predisconnect_handler, void*);
110  amps_result(*disconnectFunc)(amps_handle, amps_handler, void*);
111  amps_result(*receiveFunc)(amps_handle, amps_handler, void*);
112  amps_result(*sendFunc)(amps_handle, amps_handle);
113  amps_result(*sendWithVersionFunc)(amps_handle, amps_handle, unsigned*);
114  const amps_char*(*getError)(amps_handle);
115  void(*closeFunc)(amps_handle);
116  void(*destroyFunc)(amps_handle);
117  amps_result(*reconnectFunc)(amps_handle, unsigned);
118  amps_result(*setReadTimeoutFunc)(amps_handle,int);
119  amps_result(*setIdleTimeFunc)(amps_handle,int);
120  void(*setTransportFilterFunc)(amps_handle, amps_transport_filter_function, void*);
121  void(*setThreadCreatedCallback)(amps_handle, amps_thread_created_callback, void*);
122 } transport_entry_t;
123 
124 extern transport_entry_t g_transports[];
125 extern size_t g_transport_count;
126 typedef struct
127 {
128  char* begin;
129  size_t length;
130  short owner;
131  size_t capacity;
132 } amps_field_t;
133 
134 
135 typedef struct
136 {
137  const char* rawBuffer;
138  size_t length;
139  size_t capacity;
140  unsigned long long bitmask;
141  amps_field_t fields[MESSAGEFIELDS];
142  amps_field_t data;
143 } amps_message_t;
144 
145 typedef struct
146 {
147  char name[8];
148  int(*serializeFunc)(amps_handle message, amps_char* buffer, size_t length);
149  amps_result(*preDeserializeFunc)(amps_handle message, const amps_char* buffer, size_t length);
150  amps_result(*deserializeFunc)(amps_handle message, size_t startingPosition, unsigned long* bytesRead);
151 } protocol_entry_t;
152 extern protocol_entry_t g_message_protocols[];
153 extern size_t g_message_protocol_count;
154 
155 
156 
162 int amps_message_get_protocol(
163  const amps_char* protocolname);
164 
165 int amps_message_serialize(
166  amps_handle message,
167  int serializer,
168  amps_char* buffer,
169  size_t length);
170 
171 amps_result amps_message_pre_deserialize(
172  amps_handle message,
173  int serializer,
174  const amps_char* buffer,
175  size_t length);
176 
177 amps_result amps_message_deserialize(
178  amps_handle message,
179  int serializer,
180  size_t startingPosition,
181  unsigned long* bytesRead);
182 
183 
187 amps_result amps_protocol_pre_deserialize(amps_handle message,const amps_char* buffer,size_t length);
188 amps_result amps_protocol_deserialize(amps_handle message,size_t startingPosition,unsigned long* bytesRead);
189 int amps_protocol_serialize(amps_handle message,amps_char* buffer,size_t length);
190 
191 #ifndef _WIN32
192 int amps_spin_lock_counted(pthread_mutex_t* lock_);
193 void amps_spin_lock_unlimited(pthread_mutex_t* lock_);
194 void amps_cleanup_unlock_mutex(void* m);
195 void amps_cleanup_free_buffer(void* data);
196 #endif
197 
198 typedef void(*_amps_atfork_callback_function)(void*,int);
199 void amps_atfork_init(void);
200 void amps_atfork_add(void*, _amps_atfork_callback_function);
201 void amps_atfork_remove(void*);
202 
203 
204 #endif