Faspstream Manager C/C++ API  3.6.1
A C and C++ language interface to basic streaming over the fasp protocol
fasp_stream_client.h
Go to the documentation of this file.
1 /*
2  * Aspera, Inc.
3  *
4  * This is a C wrapper around the FaspStreamClient.
5  */
6 
8 
9 #ifndef ASPERA_FASP_STREAM_CLIENT_WRAPPER_H
10 #define ASPERA_FASP_STREAM_CLIENT_WRAPPER_H
11 
12 #include <stdlib.h>
13 #include <fasp_stream_channel.h>
14 
15 #ifdef WIN32
16 
17 #ifdef FASPSTREAM_CPP_EXPORTS
18 #define FASPSTREAM_C_API __declspec(dllexport)
19 #else
20 #define FASPSTREAM_C_API __declspec(dllimport)
21 #endif
22 
23 #else /* NOT WIN32 */
24 #define FASPSTREAM_C_API
25 #endif
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 struct fasp_stream_client;
32 typedef struct fasp_stream_client fasp_stream_client_t;
33 
42 int
43 fasp_stream_client_new(char *app_id, fasp_stream_client_t **fsc);
44 
54 int
57 
70 int
72 
73 
83 int
85 
97 int
99 
108 int
110 
124 int
125 fasp_stream_client_write(fasp_stream_client_t *fsc, char *buff, size_t len);
126 
140 int
141 fasp_stream_client_read(fasp_stream_client_t *fsc, char *buff, size_t len);
142 
143 /* ---------- GETTERS / SETTERS ---------- */
144 
147 
149 void
151 
153 int
155 
157 void
159 
161 int
163 
165 void
167 
169 int
171 
173 void
175 
177 int
179 
181 void
183 
185 const char *
187 
189 void
191 
193 int
195 
197 void
199 
201 int
203 
205 void
207 
209 int
211 
213 void
215 
217 int
219 
221 void
223 
225 int
227 
229 void
231 
233 int
235 
237 void
239 
241 int
243 
245 void
247 
249 int
251 
253 void
255  int aggressive);
256 
258 const char *
260 
262 void
264  char *path);
265 
267 int
269 
271 void
273  int milliseconds);
274 
276 void
278  int transfer_mode);
279 
281 int
283 
285 void
287  char *private_key_file);
288 
290 const char *
292 
294 void
296  char *ssh_user);
297 
299 const char *
301 
303 void
305  char *log_directory);
306 
308 const char *
310 
312 void
314  char *command_to_execute);
315 
317 const char *
319 
321 void
323 char *license);
324 
326 const char *
328 
346 void
348 
349 #ifdef __cplusplus
350 };
351 #endif
352 
353 #endif
354 
FASPSTREAM_C_API int fasp_stream_client_write(fasp_stream_client_t *fsc, char *buff, size_t len)
FASPSTREAM_C_API int fasp_stream_client_get_cipher_type(fasp_stream_client_t *fsc)
FASPSTREAM_C_API int fasp_stream_client_get_force_send_milliseconds(fasp_stream_client_t *fsc)
FASPSTREAM_C_API void fasp_stream_client_set_command_to_execute(fasp_stream_client_t *fsc, char *command_to_execute)
FASPSTREAM_C_API void fasp_stream_client_set_lock_policy(fasp_stream_client_t *fsc, int lock)
FASPSTREAM_C_API void fasp_stream_client_set_license(fasp_stream_client_t *fsc, char *license)
FASPSTREAM_C_API void fasp_stream_client_set_ssh_user(fasp_stream_client_t *fsc, char *ssh_user)
FASPSTREAM_C_API const char * fasp_stream_client_get_private_key_file(fasp_stream_client_t *fsc)
FASPSTREAM_C_API void fasp_stream_client_set_transfer_mode(fasp_stream_client_t *fsc, int transfer_mode)
FASPSTREAM_C_API int fasp_stream_client_get_rate_minimum(fasp_stream_client_t *fsc)
FASPSTREAM_C_API void fasp_stream_client_set_rate_minimum(fasp_stream_client_t *fsc, int minimum)
FASPSTREAM_C_API int fasp_stream_client_abort(fasp_stream_client_t *fsc)
FASPSTREAM_C_API int fasp_stream_client_new(char *app_id, fasp_stream_client_t **fsc)
FASPSTREAM_C_API void fasp_stream_client_set_cipher_type(fasp_stream_client_t *fsc, int type)
FASPSTREAM_C_API int fasp_stream_client_get_datagram_size(fasp_stream_client_t *fsc)
FASPSTREAM_C_API void fasp_stream_client_set_datagram_size(fasp_stream_client_t *fsc, int size)
FASPSTREAM_C_API int fasp_stream_client_is_lock_policy(fasp_stream_client_t *fsc)
FASPSTREAM_C_API int fasp_stream_client_get_port(fasp_stream_client_t *fsc)
FASPSTREAM_C_API const char * fasp_stream_client_get_log_directory(fasp_stream_client_t *fsc)
FASPSTREAM_C_API int fasp_stream_client_get_transfer_mode(fasp_stream_client_t *fsc)
FASPSTREAM_C_API int fasp_stream_client_is_lock_target(fasp_stream_client_t *fsc)
FASPSTREAM_C_API void fasp_stream_client_set_faspstream_path(fasp_stream_client_t *fsc, char *path)
FASPSTREAM_C_API int fasp_stream_client_get_policy(fasp_stream_client_t *fsc)
#define FASPSTREAM_C_API
Definition: fasp_stream_client.h:24
Definition: fasp_stream_channel.h:39
FASPSTREAM_C_API const char * fasp_stream_client_get_hostname(fasp_stream_client_t *fsc)
FASPSTREAM_C_API void fasp_stream_client_set_lock_minimum(fasp_stream_client_t *fsc, int lock_min)
FASPSTREAM_C_API void fasp_stream_client_set_max_memory(fasp_stream_client_t *fsc, int max_mem)
FASPSTREAM_C_API int fasp_stream_client_read(fasp_stream_client_t *fsc, char *buff, size_t len)
FASPSTREAM_C_API int fasp_stream_client_destroy(fasp_stream_client_t *fsc)
FASPSTREAM_C_API void fasp_stream_client_set_chunk_size(fasp_stream_client_t *fsc, int size)
FASPSTREAM_C_API int fasp_stream_client_connect(fasp_stream_client_t *fsc, char *host)
FASPSTREAM_C_API void fasp_stream_client_register_log_callback(fasp_stream_client_t *fsc, log_callback_f log_function)
FASPSTREAM_C_API int fasp_stream_client_get_chunk_size(fasp_stream_client_t *fsc)
FASPSTREAM_C_API int fasp_stream_channel_client_new(char *app_id, fasp_stream_client_t **fsc, fasp_stream_socket_wrapper_t *sock)
FASPSTREAM_C_API int fasp_stream_client_get_udp_port(fasp_stream_client_t *fsc)
FASPSTREAM_C_API int fasp_stream_client_get_max_memory(fasp_stream_client_t *fsc)
FASPSTREAM_C_API void fasp_stream_client_set_udp_port(fasp_stream_client_t *fsc, int port)
struct fasp_stream_client fasp_stream_client_t
Definition: fasp_stream_client.h:32
FASPSTREAM_C_API void fasp_stream_client_set_port(fasp_stream_client_t *fsc, int tcp_port)
FASPSTREAM_C_API const char * fasp_stream_client_get_license(fasp_stream_client_t *fsc)
FASPSTREAM_C_API int fasp_stream_client_is_lock_minimum(fasp_stream_client_t *fsc)
FASPSTREAM_C_API const char * fasp_stream_client_get_faspstream_path(fasp_stream_client_t *fsc)
FASPSTREAM_C_API void fasp_stream_client_set_private_key_file(fasp_stream_client_t *fsc, char *private_key_file)
FASPSTREAM_C_API int fasp_stream_client_cleanup(fasp_stream_client_t *fsc)
FASPSTREAM_C_API void fasp_stream_client_set_force_send_milliseconds(fasp_stream_client_t *fsc, int milliseconds)
FASPSTREAM_C_API const char * fasp_stream_client_get_ssh_user(fasp_stream_client_t *fsc)
FASPSTREAM_C_API int fasp_stream_client_get_aggressiveness(fasp_stream_client_t *fsc)
FASPSTREAM_C_API const char * fasp_stream_client_get_command_to_execute(fasp_stream_client_t *fsc)
FASPSTREAM_C_API int fasp_stream_client_get_rate_target(fasp_stream_client_t *fsc)
FASPSTREAM_C_API void fasp_stream_client_set_lock_target(fasp_stream_client_t *fsc, int target)
FASPSTREAM_C_API void fasp_stream_client_set_log_directory(fasp_stream_client_t *fsc, char *log_directory)
void(* log_callback_f)(char const *s)
Definition: fasp_stream_constants.h:67
FASPSTREAM_C_API void fasp_stream_client_set_aggressiveness(fasp_stream_client_t *fsc, int aggressive)
FASPSTREAM_C_API void fasp_stream_client_set_hostname(fasp_stream_client_t *fsc, char *name)
FASPSTREAM_C_API void fasp_stream_client_set_policy(fasp_stream_client_t *fsc, int new_policy)
FASPSTREAM_C_API void fasp_stream_client_set_rate_target(fasp_stream_client_t *fsc, int target)