1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
#ifndef __CL_COMMLIB_H
#define __CL_COMMLIB_H
/*___INFO__MARK_BEGIN__*/
/*************************************************************************
*
* The Contents of this file are made available subject to the terms of
* the Sun Industry Standards Source License Version 1.2
*
* Sun Microsystems Inc., March, 2001
*
*
* Sun Industry Standards Source License Version 1.2
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.2 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://gridengine.sunsource.net/Gridengine_SISSL_license.html
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2001 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
************************************************************************/
/*___INFO__MARK_END__*/
#include "basis_types.h"
#include "comm/lists/cl_lists.h"
#include "comm/cl_data_types.h"
#include "comm/cl_communication.h"
#define CL_COM_DEBUG_CLIENT_NAME "debug_client"
/* commlib init and hostlist functions */
cl_raw_list_t* cl_com_get_host_list(void);
cl_raw_list_t* cl_com_get_log_list(void);
cl_raw_list_t* cl_com_get_endpoint_list(void);
int cl_com_set_parameter_list_value(const char* parameter, char* value);
int cl_com_get_parameter_list_value(const char* parameter, char** value);
int cl_com_get_parameter_list_string(char** param_string);
int cl_com_remove_parameter_list_value(const char* parameter);
int cl_com_update_parameter_list(char* parameter);
/* application log functions */
int cl_commlib_push_application_error(cl_log_t cl_err_type, int cl_error, const char* cl_info);
int cl_com_setup_commlib(cl_thread_mode_t t_mode, cl_log_t debug_level, cl_log_func_t flush_func);
bool cl_com_setup_commlib_complete(void);
int cl_com_cleanup_commlib(void);
/* local handle functions */
cl_com_handle_t* cl_com_create_handle(int* commlib_error,
cl_framework_t framework,
cl_xml_connection_type_t data_flow_type ,
bool service_provider ,
int port,
cl_tcp_connect_t tcp_connect_mode,
char* component_name,
unsigned long component_id,
int select_sec_timeout,
int select_usec_timeout);
int cl_commlib_shutdown_handle (cl_com_handle_t* handle, bool return_for_messages );
cl_com_handle_t* cl_com_get_handle(const char* component_name,
unsigned long component_id); /* CR check */
/* commlib parameter functions */
int cl_com_set_synchron_receive_timeout(cl_com_handle_t* handle, int timeout);
int cl_com_set_handle_fds(cl_com_handle_t* handle, int** fd_array, unsigned long* fd_count_back);
int cl_com_get_service_port(cl_com_handle_t* handle, int* port);
int cl_com_get_connect_port(cl_com_handle_t* handle, int* port);
int cl_com_add_allowed_host (cl_com_handle_t* handle, char* hostname);
int cl_com_remove_allowed_host (cl_com_handle_t* handle, char* hostname);
int cl_com_set_alias_file(const char* alias_file);
int cl_com_set_alias_file_dirty(void);
int cl_com_append_host_alias(char* local_resolved_name, char* alias_name);
int cl_com_remove_host_alias(char* alias_name);
int cl_com_specify_ssl_configuration(cl_ssl_setup_t* new_config);
int cl_com_append_known_endpoint_from_name(char* unresolved_comp_host, char* comp_name, unsigned long comp_id, int service_port, cl_xml_connection_autoclose_t autoclose, bool is_static );
int cl_com_remove_known_endpoint_from_name(const char* unresolved_comp_host, const char* comp_name, unsigned long comp_id);
int cl_com_get_known_endpoint_port_from_name(char* unresolved_comp_host, char* comp_name, unsigned long comp_id, int* service_port );
int cl_com_get_known_endpoint_autoclose_mode_from_name(char* unresolved_comp_host, char* comp_name, unsigned long comp_id, cl_xml_connection_autoclose_t* auto_close_mode );
int cl_com_append_known_endpoint(cl_com_endpoint_t* endpoint, int service_port, cl_xml_connection_autoclose_t autoclose, bool is_static );
int cl_com_remove_known_endpoint(cl_com_endpoint_t* endpoint);
int cl_com_get_known_endpoint_port(cl_com_endpoint_t* endpoint, int* service_port );
int cl_com_get_known_endpoint_autoclose_mode(cl_com_endpoint_t* endpoint, cl_xml_connection_autoclose_t* auto_close_mode );
int cl_com_set_max_connections (cl_com_handle_t* handle, unsigned long value);
int cl_com_get_max_connections (cl_com_handle_t* handle, unsigned long* value);
int cl_com_set_auto_close_mode(cl_com_handle_t* handle, cl_xml_connection_autoclose_t mode );
int cl_com_get_auto_close_mode(cl_com_handle_t* handle, cl_xml_connection_autoclose_t* mode );
int cl_com_set_max_connection_close_mode(cl_com_handle_t* handle, cl_max_count_t mode);
int cl_com_get_max_connection_close_mode(cl_com_handle_t* handle, cl_max_count_t* mode);
int cl_com_get_actual_statistic_data(cl_com_handle_t* handle, cl_com_handle_statistic_t** statistics );
/* commlib external file descriptor functions */
int cl_com_external_fd_register(cl_com_handle_t* handle, int fd, cl_fd_func_t callback, cl_select_method_t mode, void *user_data);
int cl_com_external_fd_unregister(cl_com_handle_t* handle, int fd);
int cl_com_external_fd_set_write_ready(cl_com_handle_t* handle, int fd);
/* application can set application status for SIRM messages */
int cl_com_set_status_func(cl_app_status_func_t status_func);
/* application can set an error function */
int cl_com_set_error_func(cl_error_func_t error_func);
int cl_com_set_tag_name_func(cl_tag_name_func_t tag_name_func);
int cl_com_setup_callback_functions(cl_com_connection_t* connection);
/* allow application to send messages to connected debug clients */
int cl_com_application_debug(cl_com_handle_t* handle, const char* message);
int cl_com_set_application_debug_client_callback_func(cl_app_debug_client_func_t);
char* cl_com_get_resolvable_hosts(void);
char* cl_com_get_unresolvable_hosts(void);
unsigned long cl_com_messages_in_send_queue(cl_com_handle_t *handle);
bool cl_com_is_valid_fd (int fd);
cl_thread_mode_t cl_commlib_get_thread_state(void);
int cl_com_setup_connection (cl_com_handle_t* handle,
cl_com_connection_t** connection );
/*
TODO: cleanup function names !!!
TODO: ADOC Header !!!
*/
/* typical user function calls */
int cl_commlib_trigger (cl_com_handle_t* handle, int synchron);
int cl_commlib_close_connection (cl_com_handle_t* handle,
char* un_resolved_hostname, char* component_name, unsigned long component_id,
bool return_for_messages );
int cl_commlib_open_connection (cl_com_handle_t* handle,
char* un_resolved_hostname, char* component_name, unsigned long component_id);
int cl_commlib_receive_message (cl_com_handle_t* handle,
char* un_resolved_hostname, char* component_name, unsigned long component_id,
bool synchron,
unsigned long response_mid,
cl_com_message_t** message,
cl_com_endpoint_t** sender );
int cl_commlib_send_message (cl_com_handle_t* handle,
char* un_resolved_hostname, char* component_name, unsigned long component_id,
cl_xml_ack_type_t ack_type ,
cl_byte_t** data, unsigned long size ,
unsigned long* mid ,
unsigned long response_mid,
unsigned long tag,
bool copy_data,
bool wait_for_ack );
int cl_commlib_check_for_ack (cl_com_handle_t* handle,
char* un_resolved_hostname, char* component_name, unsigned long component_id,
unsigned long mid ,
bool do_block);
int cl_commlib_get_endpoint_status(cl_com_handle_t* handle,
char* un_resolved_hostname, char* component_name, unsigned long component_id,
cl_com_SIRM_t** status);
int cl_commlib_search_endpoint (cl_com_handle_t* handle,
char* un_resolved_hostname, char* component_name, unsigned long component_id,
bool only_connected,
cl_raw_list_t** endpoint_list);
int cl_commlib_get_connect_time(cl_com_handle_t* handle, const char* un_resolved_hostname, const char* component_name, unsigned long component_id, unsigned long* msg_time);
/* defines from old commlib */
#define HEARD_FROM_TIMEOUT 1 /* dummy parameter */
int cl_commlib_set_connection_param(cl_com_handle_t* handle, int parameter, int value);
int cl_commlib_get_connection_param(cl_com_handle_t* handle, int parameter, int* value);
bool cl_commlib_get_global_param(cl_global_settings_params_t parameter);
int cl_commlib_set_global_param(cl_global_settings_params_t parameter, bool value);
int cl_commlib_get_last_message_time(cl_com_handle_t* handle, const char* un_resolved_hostname, const char* component_name, unsigned long component_id, unsigned long* msg_time);
/* dummy defines for old lib compatibility */
#define COMMD_NACK_UNKNOWN_HOST CL_RETVAL_UNKOWN_HOST_ERROR /* TODO: check this define */
#define COMMD_NACK_CONFLICT CL_RETVAL_ENDPOINT_NOT_UNIQUE
#define CL_FIRST_FREE_EC 32
#ifndef CL_MAXHOSTLEN
#define CL_MAXHOSTLEN CL_MAXHOSTNAMELEN_LENGTH /* TODO: remove this define */
#endif
int getuniquehostname(const char *hostin, char *hostout, int refresh_aliases);
#endif /* __CL_COMMLIB_H */
|
