AMPS C/C++ Client Class Reference
AMPS C/C++ Client Version 5.3.4.5
amps_impl.h
1 /*//////////////////////////////////////////////////////////////////////////
2 //
3 // Copyright (c) 2010-2025 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/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  #define AMPS_CLOSESOCKET closesocket
47 
48 #else
49  #include <pthread.h>
50  #include <unistd.h>
51  #include <sys/socket.h>
52  #include <netinet/in.h>
53  #include <netinet/tcp.h>
54  #include <arpa/inet.h>
55  #define _AMPS_SNPRINTF snprintf
56  #define _AMPS_KEYCREATE pthread_key_create
57  #define _AMPS_TLS_KEY pthread_key_t
58  #define AMPS_CLOSESOCKET close
59  #define _AMPS_STRNDUP strndup
60 
61  #ifndef SO_DOMAIN
62  #define AMPS_SO_DOMAIN 39
63  #else
64  #define AMPS_SO_DOMAIN (SO_DOMAIN)
65  #endif
66 
67 #endif
68 
69 #define AMPS_MIN(x,y) ((x)<(y)?(x):(y))
70 #define AMPS_MAX(x,y) ((x)>(y)?(x):(y))
71 
72 typedef enum
73 {
74  AMPS_PREFER_IPV4,
75  AMPS_PREFER_IPV6
76 }
77 amps_ip_protocol_preference;
78 #define AMPS_DEFAULT_IP_PROTOCOL_PREFERENCE AMPS_PREFER_IPV4
79 
80 typedef struct
81 {
82  char clientName[128];
83  size_t transportType;
84  amps_handle transport;
85  char lastError[1024];
86 
87  amps_predisconnect_handler predisconnectHandler;
88  void* predisconnectHandlerUserData;
89  amps_handler disconnectHandler;
90  void* disconnectHandlerUserData;
91 
92  amps_handler messageHandler;
93  void* messageHandlerUserData;
94 
95  amps_transport_filter_function transportFilterFunction;
96  void* transportFilterFunctionUserData;
97 
98  amps_thread_created_callback threadCreatedCallback;
99  void* threadCreatedCallbackUserData;
100 
101  amps_thread_exit_callback threadExitCallback;
102  void* threadExitCallbackUserData;
103 
104  amps_http_preflight_callback httpPreflightCallback;
105  void* httpPreflightCallbackUserData;
106 }
107 amps_client_t;
108 
109 typedef struct
110 {
111  char name[8];
112  amps_handle(*createFunc)(void);
113  amps_result(*connectFunc)(amps_handle, const amps_char*);
114  amps_result(*predisconnectFunc)(amps_handle, amps_predisconnect_handler, void*);
115  amps_result(*disconnectFunc)(amps_handle, amps_handler, void*);
116  amps_result(*receiveFunc)(amps_handle, amps_handler, void*);
117  amps_result(*sendFunc)(amps_handle, amps_handle);
118  amps_result(*sendWithVersionFunc)(amps_handle, amps_handle, unsigned*);
119  const amps_char* (*getError)(amps_handle);
120  void(*closeFunc)(amps_handle);
121  void(*destroyFunc)(amps_handle);
122  amps_result(*reconnectFunc)(amps_handle, unsigned);
123  amps_result(*setReadTimeoutFunc)(amps_handle, int);
124  amps_result(*setIdleTimeFunc)(amps_handle, int);
125  void(*setTransportFilterFunc)(amps_handle, amps_transport_filter_function, void*);
126  void(*setThreadCreatedCallback)(amps_handle, amps_thread_created_callback, void*);
127  void(*setThreadExitCallback)(amps_handle, amps_thread_exit_callback, void*);
128  void(*setHttpPreflightCallback)(amps_handle, amps_http_preflight_callback, void*);
129  AMPS_SOCKET(*getSocket)(amps_handle);
130 } transport_entry_t;
131 
132 extern transport_entry_t g_transports[];
133 extern size_t g_transport_count;
134 typedef struct
135 {
136  char* begin;
137  size_t length;
138  short owner;
139  size_t capacity;
140 } amps_field_t;
141 
142 
143 typedef struct
144 {
145  const char* rawBuffer;
146  size_t length;
147  size_t capacity;
148  unsigned long long bitmask;
149  amps_field_t fields[MESSAGEFIELDS];
150  amps_field_t data;
151 } amps_message_t;
152 
153 typedef struct
154 {
155  char name[8];
156  int(*serializeFunc)(amps_handle message, amps_char* buffer, size_t length);
157  amps_result(*preDeserializeFunc)(amps_handle message, const amps_char* buffer, size_t length);
158  amps_result(*deserializeFunc)(amps_handle message, size_t startingPosition, unsigned long* bytesRead);
159 } protocol_entry_t;
160 extern protocol_entry_t g_message_protocols[];
161 extern size_t g_message_protocol_count;
162 
163 
164 
170 amps_int64_t amps_message_get_protocol(
171  const amps_char* protocolname);
172 
173 int amps_message_serialize(
174  amps_handle message,
175  amps_int64_t serializer,
176  amps_char* buffer,
177  size_t length);
178 
179 amps_result amps_message_pre_deserialize(
180  amps_handle message,
181  amps_int64_t serializer,
182  const amps_char* buffer,
183  size_t length);
184 
185 amps_result amps_message_deserialize(
186  amps_handle message,
187  amps_int64_t serializer,
188  size_t startingPosition,
189  unsigned long* bytesRead);
190 
191 
195 amps_result amps_protocol_pre_deserialize(amps_handle message, const amps_char* buffer, size_t length);
196 amps_result amps_protocol_deserialize(amps_handle message, size_t startingPosition, unsigned long* bytesRead);
197 int amps_protocol_serialize(amps_handle message, amps_char* buffer, size_t length);
198 
199 #ifndef _WIN32
200  int amps_spin_lock_counted(pthread_mutex_t* lock_);
201  void amps_spin_lock_unlimited(pthread_mutex_t* lock_);
202  void amps_cleanup_unlock_mutex(void* m);
203  void amps_cleanup_free_buffer(void* data);
204  void amps_mutex_pair_atfork(void* vpMutex_, int code_);
205 #endif
206 
207 typedef void(*_amps_atfork_callback_function)(void*, int);
208 AMPSDLL void amps_atfork_init(void);
209 AMPSDLL void amps_atfork_add(void*, _amps_atfork_callback_function);
210 AMPSDLL void amps_atfork_remove(void*, _amps_atfork_callback_function);
211 
212 #ifdef AMPS_CPP_COUNT_THREADS
213 #if __STDC_VERSION__ >= 201100
214  extern _Atomic size_t amps_thread_create_count;
215  extern _Atomic size_t amps_thread_join_count;
216  extern _Atomic size_t amps_thread_detach_count;
217 #else
218  extern volatile size_t amps_thread_create_count;
219  extern volatile size_t amps_thread_join_count;
220  extern volatile size_t amps_thread_detach_count;
221 #endif
222 #endif
223 
224 
225 #endif