AMPS C/C++ Client Class Reference
AMPS C/C++ Client Version 5.3.4.4
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  #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_client_t;
105 
106 typedef struct
107 {
108  char name[8];
109  amps_handle(*createFunc)(void);
110  amps_result(*connectFunc)(amps_handle, const amps_char*);
111  amps_result(*predisconnectFunc)(amps_handle, amps_predisconnect_handler, void*);
112  amps_result(*disconnectFunc)(amps_handle, amps_handler, void*);
113  amps_result(*receiveFunc)(amps_handle, amps_handler, void*);
114  amps_result(*sendFunc)(amps_handle, amps_handle);
115  amps_result(*sendWithVersionFunc)(amps_handle, amps_handle, unsigned*);
116  const amps_char* (*getError)(amps_handle);
117  void(*closeFunc)(amps_handle);
118  void(*destroyFunc)(amps_handle);
119  amps_result(*reconnectFunc)(amps_handle, unsigned);
120  amps_result(*setReadTimeoutFunc)(amps_handle, int);
121  amps_result(*setIdleTimeFunc)(amps_handle, int);
122  void(*setTransportFilterFunc)(amps_handle, amps_transport_filter_function, void*);
123  void(*setThreadCreatedCallback)(amps_handle, amps_thread_created_callback, void*);
124  void(*setThreadExitCallback)(amps_handle, amps_thread_exit_callback, void*);
125  AMPS_SOCKET(*getSocket)(amps_handle);
126 } transport_entry_t;
127 
128 extern transport_entry_t g_transports[];
129 extern size_t g_transport_count;
130 typedef struct
131 {
132  char* begin;
133  size_t length;
134  short owner;
135  size_t capacity;
136 } amps_field_t;
137 
138 
139 typedef struct
140 {
141  const char* rawBuffer;
142  size_t length;
143  size_t capacity;
144  unsigned long long bitmask;
145  amps_field_t fields[MESSAGEFIELDS];
146  amps_field_t data;
147 } amps_message_t;
148 
149 typedef struct
150 {
151  char name[8];
152  int(*serializeFunc)(amps_handle message, amps_char* buffer, size_t length);
153  amps_result(*preDeserializeFunc)(amps_handle message, const amps_char* buffer, size_t length);
154  amps_result(*deserializeFunc)(amps_handle message, size_t startingPosition, unsigned long* bytesRead);
155 } protocol_entry_t;
156 extern protocol_entry_t g_message_protocols[];
157 extern size_t g_message_protocol_count;
158 
159 
160 
166 amps_int64_t amps_message_get_protocol(
167  const amps_char* protocolname);
168 
169 int amps_message_serialize(
170  amps_handle message,
171  amps_int64_t serializer,
172  amps_char* buffer,
173  size_t length);
174 
175 amps_result amps_message_pre_deserialize(
176  amps_handle message,
177  amps_int64_t serializer,
178  const amps_char* buffer,
179  size_t length);
180 
181 amps_result amps_message_deserialize(
182  amps_handle message,
183  amps_int64_t serializer,
184  size_t startingPosition,
185  unsigned long* bytesRead);
186 
187 
191 amps_result amps_protocol_pre_deserialize(amps_handle message, const amps_char* buffer, size_t length);
192 amps_result amps_protocol_deserialize(amps_handle message, size_t startingPosition, unsigned long* bytesRead);
193 int amps_protocol_serialize(amps_handle message, amps_char* buffer, size_t length);
194 
195 #ifndef _WIN32
196  int amps_spin_lock_counted(pthread_mutex_t* lock_);
197  void amps_spin_lock_unlimited(pthread_mutex_t* lock_);
198  void amps_cleanup_unlock_mutex(void* m);
199  void amps_cleanup_free_buffer(void* data);
200  void amps_mutex_pair_atfork(void* vpMutex_, int code_);
201 #endif
202 
203 typedef void(*_amps_atfork_callback_function)(void*, int);
204 AMPSDLL void amps_atfork_init(void);
205 AMPSDLL void amps_atfork_add(void*, _amps_atfork_callback_function);
206 AMPSDLL void amps_atfork_remove(void*, _amps_atfork_callback_function);
207 
208 #ifdef AMPS_CPP_COUNT_THREADS
209 #if __STDC_VERSION__ >= 201100
210  extern _Atomic size_t amps_thread_create_count;
211  extern _Atomic size_t amps_thread_join_count;
212  extern _Atomic size_t amps_thread_detach_count;
213 #else
214  extern volatile size_t amps_thread_create_count;
215  extern volatile size_t amps_thread_join_count;
216  extern volatile size_t amps_thread_detach_count;
217 #endif
218 #endif
219 
220 
221 #endif