Grid Community Toolkit  6.2.1607800521 (tag: v6.2.20201212)
globus_callback.h
Go to the documentation of this file.
1 /*
2  * Copyright 1999-2006 University of Chicago
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef GLOBUS_CALLBACK_H
18 #define GLOBUS_CALLBACK_H
19 
31 #include "globus_common_include.h"
32 #include "globus_module.h"
33 #include "globus_time.h"
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 extern
40 globus_module_descriptor_t globus_i_callback_module;
41 
54 #define GLOBUS_CALLBACK_MODULE (&globus_i_callback_module)
55 
65 #define GLOBUS_POLL_MODULE GLOBUS_CALLBACK_MODULE
66 
78 typedef enum
79 {
81  GLOBUS_CALLBACK_ERROR_INVALID_CALLBACK_HANDLE = 1024,
83  GLOBUS_CALLBACK_ERROR_INVALID_SPACE,
85  GLOBUS_CALLBACK_ERROR_MEMORY_ALLOC,
87  GLOBUS_CALLBACK_ERROR_INVALID_ARGUMENT,
89  GLOBUS_CALLBACK_ERROR_ALREADY_CANCELED,
91  GLOBUS_CALLBACK_ERROR_NO_ACTIVE_CALLBACK
92 } globus_callback_error_type_t;
93 
102 typedef int globus_callback_handle_t;
103 
112 typedef int globus_callback_space_t;
113 
121 typedef struct globus_l_callback_space_attr_s * globus_callback_space_attr_t;
122 
133 /* @{ */
134 
146 #define globus_callback_poll(a) \
147  globus_callback_space_poll((a), GLOBUS_CALLBACK_GLOBAL_SPACE)
148 
160 #define globus_poll_blocking() \
161  globus_callback_poll(&globus_i_abstime_infinity)
162 
174 #define globus_poll_nonblocking() \
175  globus_callback_poll(&globus_i_abstime_zero)
176 
188 #define globus_poll() \
189  globus_poll_nonblocking()
190 
201 #define globus_signal_poll() \
202  globus_callback_signal_poll()
203 
215 #define globus_callback_register_oneshot( \
216  callback_handle, \
217  delay_time, \
218  callback_func, \
219  callback_user_arg) \
220  globus_callback_space_register_oneshot( \
221  (callback_handle), \
222  (delay_time), \
223  (callback_func), \
224  (callback_user_arg), \
225  GLOBUS_CALLBACK_GLOBAL_SPACE)
226 
238 #define globus_callback_register_periodic( \
239  callback_handle, \
240  delay_time, \
241  period, \
242  callback_func, \
243  callback_user_arg) \
244  globus_callback_space_register_periodic( \
245  (callback_handle), \
246  (delay_time), \
247  (period), \
248  (callback_func), \
249  (callback_user_arg), \
250  GLOBUS_CALLBACK_GLOBAL_SPACE)
251 
264 #define globus_callback_register_signal_handler( \
265  signum, \
266  persist, \
267  callback_func, \
268  callback_user_arg) \
269  globus_callback_space_register_signal_handler( \
270  (signum), \
271  (persist), \
272  (callback_func), \
273  (callback_user_arg), \
274  GLOBUS_CALLBACK_GLOBAL_SPACE)
275 
276 /* @} */
277 
281 /* @{ */
282 
312 typedef
313 void
314 (*globus_callback_func_t)(
315  void * user_arg);
316 
317 /* @} */
318 
322 /* @{ */
323 
357 globus_result_t
358 globus_callback_space_register_oneshot(
359  globus_callback_handle_t * callback_handle,
360  const globus_reltime_t * delay_time,
361  globus_callback_func_t callback_func,
362  void * callback_user_arg,
363  globus_callback_space_t space);
364 
365 /* @} */
366 
370 /* @{ */
371 
409 globus_result_t
410 globus_callback_space_register_periodic(
411  globus_callback_handle_t * callback_handle,
412  const globus_reltime_t * delay_time,
413  const globus_reltime_t * period,
414  globus_callback_func_t callback_func,
415  void * callback_user_arg,
416  globus_callback_space_t space);
417 
462 globus_result_t
463 globus_callback_unregister(
464  globus_callback_handle_t callback_handle,
465  globus_callback_func_t unregister_callback,
466  void * unreg_arg,
467  globus_bool_t * active);
468 
496 globus_result_t
497 globus_callback_adjust_oneshot(
498  globus_callback_handle_t callback_handle,
499  const globus_reltime_t * new_delay);
500 
533 globus_result_t
534 globus_callback_adjust_period(
535  globus_callback_handle_t callback_handle,
536  const globus_reltime_t * new_period);
537 /* @} */
538 
542 /* @{ */
543 
585 void
586 globus_callback_space_poll(
587  const globus_abstime_t * timestop,
588  globus_callback_space_t space);
589 
608 void
609 globus_callback_signal_poll();
610 /* @} */
611 
615 /* @{ */
616 
635 globus_bool_t
636 globus_callback_get_timeout(
637  globus_reltime_t * time_left);
638 
652 globus_bool_t
653 globus_callback_has_time_expired();
654 
672 globus_bool_t
673 globus_callback_was_restarted();
674 
675 /* @} */
676 
694 #define GLOBUS_CALLBACK_GLOBAL_SPACE -2
695 
726 typedef enum
727 {
731  GLOBUS_CALLBACK_SPACE_BEHAVIOR_SINGLE,
735  GLOBUS_CALLBACK_SPACE_BEHAVIOR_SERIALIZED,
737  GLOBUS_CALLBACK_SPACE_BEHAVIOR_THREADED
738 } globus_callback_space_behavior_t;
739 
765 globus_result_t
766 globus_callback_space_init(
767  globus_callback_space_t * space,
768  globus_callback_space_attr_t attr);
769 
787 globus_result_t
788 globus_callback_space_reference(
789  globus_callback_space_t space);
790 
814 globus_result_t
815 globus_callback_space_destroy(
816  globus_callback_space_t space);
817 
835 globus_result_t
836 globus_callback_space_attr_init(
837  globus_callback_space_attr_t * attr);
838 
853 globus_result_t
854 globus_callback_space_attr_destroy(
855  globus_callback_space_attr_t attr);
856 
873 globus_result_t
874 globus_callback_space_attr_set_behavior(
875  globus_callback_space_attr_t attr,
876  globus_callback_space_behavior_t behavior);
877 
897 globus_result_t
898 globus_callback_space_attr_get_behavior(
899  globus_callback_space_attr_t attr,
900  globus_callback_space_behavior_t * behavior);
901 
914 globus_result_t
915 globus_callback_space_get(
916  globus_callback_space_t * space);
917 
929 int
930 globus_callback_space_get_depth(
931  globus_callback_space_t space);
932 
944 globus_bool_t
945 globus_callback_space_is_single(
946  globus_callback_space_t space);
947 
948 
963 #ifdef SIGINT
964 #define GLOBUS_SIGNAL_INTERRUPT SIGINT
965 #else
966 #define GLOBUS_SIGNAL_INTERRUPT 0
967 #endif
968 
1004 globus_result_t
1005 globus_callback_space_register_signal_handler(
1006  int signum,
1007  globus_bool_t persist,
1008  globus_callback_func_t callback_func,
1009  void * callback_user_arg,
1010  globus_callback_space_t space);
1011 
1036 globus_result_t
1037 globus_callback_unregister_signal_handler(
1038  int signum,
1039  globus_callback_func_t unregister_callback,
1040  void * unreg_arg);
1041 
1069 void
1070 globus_callback_add_wakeup_handler(
1071  void (*wakeup)(void *),
1072  void * user_arg);
1073 
1074 #ifdef __cplusplus
1075 }
1076 #endif
1077 
1078 #endif /* GLOBUS_CALLBACK_H */
globus_callback_space_behavior_t
globus_callback_space_behavior_t
Callback space behaviors describe how a space behaves.
Definition: globus_callback.h:726
GLOBUS_CALLBACK_ERROR_ALREADY_CANCELED
Definition: globus_callback.h:89
globus_callback_space_register_oneshot
globus_result_t globus_callback_space_register_oneshot(globus_callback_handle_t *callback_handle, const globus_reltime_t *delay_time, globus_callback_func_t callback_func, void *callback_user_arg, globus_callback_space_t space)
Register a oneshot some delay from now.
globus_callback_space_register_periodic
globus_result_t globus_callback_space_register_periodic(globus_callback_handle_t *callback_handle, const globus_reltime_t *delay_time, const globus_reltime_t *period, globus_callback_func_t callback_func, void *callback_user_arg, globus_callback_space_t space)
Register a periodic callback.
globus_callback_unregister_signal_handler
globus_result_t globus_callback_unregister_signal_handler(int signum, globus_callback_func_t unregister_callback, void *unreg_arg)
Unregister a signal handling callback.
GLOBUS_CALLBACK_SPACE_BEHAVIOR_SERIALIZED
Definition: globus_callback.h:735
globus_callback_adjust_period
globus_result_t globus_callback_adjust_period(globus_callback_handle_t callback_handle, const globus_reltime_t *new_period)
Adjust the period of a periodic callback.
GLOBUS_CALLBACK_ERROR_MEMORY_ALLOC
Definition: globus_callback.h:85
globus_callback_get_timeout
globus_bool_t globus_callback_get_timeout(globus_reltime_t *time_left)
Get the amount of time left in a callback.
GLOBUS_CALLBACK_ERROR_INVALID_ARGUMENT
Definition: globus_callback.h:87
GLOBUS_CALLBACK_ERROR_INVALID_CALLBACK_HANDLE
Definition: globus_callback.h:81
globus_bool_t
int globus_bool_t
Boolean type.
Definition: globus_types.h:93
globus_callback_space_get_depth
int globus_callback_space_get_depth(globus_callback_space_t space)
Retrieve the current nesting level of a space.
globus_callback_handle_t
int globus_callback_handle_t
Periodic callback handle.
Definition: globus_callback.h:102
globus_callback_space_init
globus_result_t globus_callback_space_init(globus_callback_space_t *space, globus_callback_space_attr_t attr)
Initialize a user space.
globus_module.h
Reference Counting Module Activation and Deactivation.
globus_callback_adjust_oneshot
globus_result_t globus_callback_adjust_oneshot(globus_callback_handle_t callback_handle, const globus_reltime_t *new_delay)
Adjust the delay of a oneshot callback.
globus_callback_error_type_t
globus_callback_error_type_t
Error types.
Definition: globus_callback.h:78
globus_callback_add_wakeup_handler
void globus_callback_add_wakeup_handler(void(*wakeup)(void *), void *user_arg)
Register a wakeup handler with callback library.
GLOBUS_CALLBACK_ERROR_NO_ACTIVE_CALLBACK
Definition: globus_callback.h:91
globus_callback_unregister
globus_result_t globus_callback_unregister(globus_callback_handle_t callback_handle, globus_callback_func_t unregister_callback, void *unreg_arg, globus_bool_t *active)
Unregister a callback.
globus_callback_space_reference
globus_result_t globus_callback_space_reference(globus_callback_space_t space)
Take a reference to a space.
globus_callback_space_register_signal_handler
globus_result_t globus_callback_space_register_signal_handler(int signum, globus_bool_t persist, globus_callback_func_t callback_func, void *callback_user_arg, globus_callback_space_t space)
Fire a callback when the specified signal is received.
globus_callback_space_is_single
globus_bool_t globus_callback_space_is_single(globus_callback_space_t space)
See if the specified space is a single threaded behavior space.
globus_callback_space_poll
void globus_callback_space_poll(const globus_abstime_t *timestop, globus_callback_space_t space)
Poll for ready callbacks.
globus_callback_has_time_expired
globus_bool_t globus_callback_has_time_expired()
See if there is remaining time in a callback.
globus_callback_space_attr_init
globus_result_t globus_callback_space_attr_init(globus_callback_space_attr_t *attr)
Initialize a space attr.
GLOBUS_CALLBACK_SPACE_BEHAVIOR_SINGLE
Definition: globus_callback.h:731
GLOBUS_CALLBACK_ERROR_INVALID_SPACE
Definition: globus_callback.h:83
GLOBUS_CALLBACK_SPACE_BEHAVIOR_THREADED
Definition: globus_callback.h:737
globus_callback_signal_poll
void globus_callback_signal_poll()
Signal the poll.
globus_callback_space_attr_set_behavior
globus_result_t globus_callback_space_attr_set_behavior(globus_callback_space_attr_t attr, globus_callback_space_behavior_t behavior)
Set the behavior of a space.
globus_callback_space_attr_destroy
globus_result_t globus_callback_space_attr_destroy(globus_callback_space_attr_t attr)
Destroy a space attr.
globus_result_t
uint32_t globus_result_t
Definition: globus_types.h:99
globus_callback_space_attr_get_behavior
globus_result_t globus_callback_space_attr_get_behavior(globus_callback_space_attr_t attr, globus_callback_space_behavior_t *behavior)
Get the behavior associated with an attr.
globus_callback_space_attr_t
struct globus_l_callback_space_attr_s * globus_callback_space_attr_t
Callback space attribute.
Definition: globus_callback.h:121
globus_time.h
Time Types and Macros.
globus_callback_space_destroy
globus_result_t globus_callback_space_destroy(globus_callback_space_t space)
Destroy a reference to a user space.
globus_callback_was_restarted
globus_bool_t globus_callback_was_restarted()
See if a callback has been restarted.
globus_callback_func_t
void(* globus_callback_func_t)(void *user_arg)
Globus callback prototype.
Definition: globus_callback.h:314
globus_callback_space_get
globus_result_t globus_callback_space_get(globus_callback_space_t *space)
Retrieve the space of a currently running callback.
globus_common_include.h
Include System Headers.
globus_callback_space_t
int globus_callback_space_t
Callback space handle.
Definition: globus_callback.h:112
globus_module_descriptor_s
Module Descriptor.
Definition: globus_module.h:71
Generated by   doxygen 1.8.13