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