proton  0
reactor.h
Go to the documentation of this file.
1 #ifndef PROTON_REACTOR_H
2 #define PROTON_REACTOR_H 1
3 
4 /*
5  *
6  * Licensed to the Apache Software Foundation (ASF) under one
7  * or more contributor license agreements. See the NOTICE file
8  * distributed with this work for additional information
9  * regarding copyright ownership. The ASF licenses this file
10  * to you under the Apache License, Version 2.0 (the
11  * "License"); you may not use this file except in compliance
12  * with the License. You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing,
17  * software distributed under the License is distributed on an
18  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19  * KIND, either express or implied. See the License for the
20  * specific language governing permissions and limitations
21  * under the License.
22  *
23  */
24 
25 #include <proton/import_export.h>
26 #include <proton/type_compat.h>
27 #include <proton/event.h>
28 #include <proton/selectable.h>
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 /**
35  * @file
36  *
37  * Reactor API for proton.
38  *
39  * @defgroup reactor Reactor
40  * @ingroup reactor
41  * @{
42  */
43 
44 typedef struct pn_handler_t pn_handler_t;
45 typedef struct pn_reactor_t pn_reactor_t;
47 typedef struct pn_timer_t pn_timer_t;
48 typedef struct pn_task_t pn_task_t;
49 
51 PN_EXTERN pn_handler_t *pn_handler_new(void (*dispatch)(pn_handler_t *, pn_event_t *, pn_event_type_t), size_t size,
52  void (*finalize)(pn_handler_t *));
54 PN_EXTERN void *pn_handler_mem(pn_handler_t *handler);
55 PN_EXTERN void pn_handler_add(pn_handler_t *handler, pn_handler_t *child);
58 
75 PN_EXTERN void pn_reactor_update(pn_reactor_t *reactor, pn_selectable_t *selectable);
76 PN_EXTERN pn_acceptor_t *pn_reactor_acceptor(pn_reactor_t *reactor, const char *host, const char *port,
77  pn_handler_t *handler);
85 PN_EXTERN pn_task_t *pn_reactor_schedule(pn_reactor_t *reactor, int delay, pn_handler_t *handler);
86 
87 
89 
95 
97 
98 PN_EXTERN pn_reactor_t *pn_class_reactor(const pn_class_t *clazz, void *object);
101 
104 
105 /** @}
106  */
107 
108 #ifdef __cplusplus
109 }
110 #endif
111 
112 #endif /* reactor.h */
PN_EXTERN void pn_reactor_set_handler(pn_reactor_t *reactor, pn_handler_t *handler)
PN_EXTERN void pn_reactor_free(pn_reactor_t *reactor)
uint32_t pn_millis_t
Definition: types.h:47
PN_EXTERN pn_handler_t * pn_reactor_get_global_handler(pn_reactor_t *reactor)
PN_EXTERN void pn_handler_add(pn_handler_t *handler, pn_handler_t *child)
PN_EXTERN pn_acceptor_t * pn_reactor_acceptor(pn_reactor_t *reactor, const char *host, const char *port, pn_handler_t *handler)
PN_EXTERN void pn_reactor_start(pn_reactor_t *reactor)
struct pn_record_t pn_record_t
Definition: object.h:46
Definition: object.h:48
struct pn_connection_t pn_connection_t
An AMQP Connection object.
Definition: types.h:112
PN_EXTERN pn_handler_t * pn_reactor_get_handler(pn_reactor_t *reactor)
PN_EXTERN pn_timestamp_t pn_reactor_now(pn_reactor_t *reactor)
The selectable API provides an interface for integration with third party event loops.
struct pn_event_t pn_event_t
An event provides notification of a state change within the protocol engine's object model...
Definition: event.h:78
PN_EXTERN pn_reactor_t * pn_class_reactor(const pn_class_t *clazz, void *object)
PN_EXTERN int pn_reactor_wakeup(pn_reactor_t *reactor)
struct pn_io_t pn_io_t
A pn_io_t manages IO for a group of pn_socket_t handles.
Definition: io.h:82
PN_EXTERN pn_io_t * pn_reactor_io(pn_reactor_t *reactor)
PN_EXTERN pn_handler_t * pn_handler(void(*dispatch)(pn_handler_t *, pn_event_t *, pn_event_type_t))
pn_event_type_t
An event type.
Definition: event.h:83
int64_t pn_timestamp_t
Definition: types.h:50
PN_EXTERN void pn_reactor_update(pn_reactor_t *reactor, pn_selectable_t *selectable)
struct pn_collector_t pn_collector_t
An event collector.
Definition: types.h:244
PN_EXTERN void pn_reactor_set_timeout(pn_reactor_t *reactor, pn_millis_t timeout)
PN_EXTERN pn_millis_t pn_reactor_get_timeout(pn_reactor_t *reactor)
PN_EXTERN bool pn_reactor_process(pn_reactor_t *reactor)
PN_EXTERN void * pn_handler_mem(pn_handler_t *handler)
struct pn_handler_t pn_handler_t
Definition: reactor.h:44
PN_EXTERN void pn_reactor_run(pn_reactor_t *reactor)
PN_EXTERN void pn_handler_clear(pn_handler_t *handler)
PN_EXTERN pn_timestamp_t pn_reactor_mark(pn_reactor_t *reactor)
#define PN_EXTERN
Definition: import_export.h:53
PN_EXTERN pn_reactor_t * pn_event_reactor(pn_event_t *event)
PN_EXTERN pn_reactor_t * pn_reactor(void)
struct pn_acceptor_t pn_acceptor_t
Definition: reactor.h:46
Event API for the proton Engine.
PN_EXTERN pn_reactor_t * pn_object_reactor(void *object)
PN_EXTERN void pn_handler_dispatch(pn_handler_t *handler, pn_event_t *event, pn_event_type_t type)
struct pn_selectable_t pn_selectable_t
A selectable object provides an interface that can be used to incorporate proton's I/O into third par...
Definition: selectable.h:70
PN_EXTERN bool pn_reactor_quiesced(pn_reactor_t *reactor)
PN_EXTERN void pn_record_set_handler(pn_record_t *record, pn_handler_t *handler)
PN_EXTERN pn_handler_t * pn_handler_new(void(*dispatch)(pn_handler_t *, pn_event_t *, pn_event_type_t), size_t size, void(*finalize)(pn_handler_t *))
PN_EXTERN void pn_timer_tick(pn_timer_t *timer, pn_timestamp_t now)
PN_EXTERN void pn_reactor_set_global_handler(pn_reactor_t *reactor, pn_handler_t *handler)
PN_EXTERN void pn_reactor_stop(pn_reactor_t *reactor)
PN_EXTERN void pn_acceptor_close(pn_acceptor_t *acceptor)
struct pn_task_t pn_task_t
Definition: reactor.h:48
PN_EXTERN pn_handler_t * pn_record_get_handler(pn_record_t *record)
PN_EXTERN pn_selectable_t * pn_reactor_selectable(pn_reactor_t *reactor)
PN_EXTERN pn_task_t * pn_timer_schedule(pn_timer_t *timer, pn_timestamp_t deadline)
PN_EXTERN pn_record_t * pn_task_attachments(pn_task_t *task)
struct pn_reactor_t pn_reactor_t
Definition: reactor.h:45
PN_EXTERN pn_timestamp_t pn_timer_deadline(pn_timer_t *timer)
PN_EXTERN pn_timer_t * pn_timer(pn_collector_t *collector)
PN_EXTERN void pn_handler_free(pn_handler_t *handler)
PN_EXTERN pn_record_t * pn_reactor_attachments(pn_reactor_t *reactor)
PN_EXTERN pn_task_t * pn_reactor_schedule(pn_reactor_t *reactor, int delay, pn_handler_t *handler)
struct pn_list_t pn_list_t
Definition: object.h:41
PN_EXTERN pn_connection_t * pn_reactor_connection(pn_reactor_t *reactor, pn_handler_t *handler)
PN_EXTERN pn_list_t * pn_reactor_children(pn_reactor_t *reactor)
struct pn_timer_t pn_timer_t
Definition: reactor.h:47
PN_EXTERN int pn_timer_tasks(pn_timer_t *timer)
PN_EXTERN pn_collector_t * pn_reactor_collector(pn_reactor_t *reactor)
PN_EXTERN void pn_reactor_yield(pn_reactor_t *reactor)