Qpid Proton C API 0.39.0
 
Loading...
Searching...
No Matches
connection_driver.h
Go to the documentation of this file.
1#ifndef PROTON_CONNECTION_DRIVER_H
2#define PROTON_CONNECTION_DRIVER_H 1
3
4/*
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements. See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership. The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License. You may obtain a copy of the License at
12 *
13 * http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied. See the License for the
19 * specific language governing permissions and limitations
20 * under the License.
21 */
22
77#include <proton/import_export.h>
78#include <proton/event.h>
79#include <proton/types.h>
80
81#include <stdarg.h>
82
83#ifdef __cplusplus
84extern "C" {
85#endif
86
90typedef struct pn_connection_driver_t {
91 pn_connection_t *connection;
92 pn_transport_t *transport;
93 pn_collector_t *collector;
95
113
121
127
139
152
162
168
173
178
188
194
199
204
209
218
223
231
241PN_EXTERN void pn_connection_driver_errorf(pn_connection_driver_t *d, const char *name, const char *fmt, ...);
242
246PN_EXTERN void pn_connection_driver_verrorf(pn_connection_driver_t *d, const char *name, const char *fmt, va_list);
247
252#define PN_TRANSPORT_WRITE_CLOSED PN_TRANSPORT_HEAD_CLOSED
253
258#define PN_TRANSPORT_READ_CLOSED PN_TRANSPORT_TAIL_CLOSED
259
263PN_EXTERN void pn_connection_driver_log(pn_connection_driver_t *d, const char *msg);
264
268PN_EXTERN void pn_connection_driver_logf(pn_connection_driver_t *d, const char *fmt, ...);
269
273PN_EXTERN void pn_connection_driver_vlogf(pn_connection_driver_t *d, const char *fmt, va_list ap);
274
287
292#ifdef __cplusplus
293}
294#endif
295
296#endif /* connection_driver.h */
Protocol and transport events.
A const byte buffer.
Definition: types.h:216
A non-const byte buffer.
Definition: types.h:235
bool pn_connection_driver_write_closed(pn_connection_driver_t *)
True if write side is closed.
pn_rwbytes_t pn_connection_driver_read_buffer(pn_connection_driver_t *)
Get the read buffer.
void pn_connection_driver_read_close(pn_connection_driver_t *)
Close the read side.
int pn_connection_driver_init(pn_connection_driver_t *, pn_connection_t *, pn_transport_t *)
Set connection and transport to the provided values, or create a new pn_connection_t or pn_transport_...
pn_event_t * pn_connection_driver_next_event(pn_connection_driver_t *)
Get the next event to handle.
pn_connection_t * pn_connection_driver_release_connection(pn_connection_driver_t *d)
Disassociate the driver's connection from its transport and collector and sets d->connection = NULL.
void pn_connection_driver_errorf(pn_connection_driver_t *d, const char *name, const char *fmt,...)
Set transport error.
bool pn_connection_driver_finished(pn_connection_driver_t *)
Return true if the the driver is closed for reading and writing and there are no more events.
pn_bytes_t pn_connection_driver_write_buffer(pn_connection_driver_t *)
Get the write buffer.
void pn_connection_driver_destroy(pn_connection_driver_t *)
Unbind, release and free the connection and transport.
pn_rwbytes_t pn_connection_driver_read_buffer_sized(pn_connection_driver_t *, size_t n)
Try to get a read buffer with the specified size.
bool pn_connection_driver_read_closed(pn_connection_driver_t *)
True if read side is closed.
void pn_connection_driver_logf(pn_connection_driver_t *d, const char *fmt,...)
Deprecated - Use pn_transport_logf().
pn_connection_driver_t ** pn_connection_driver_ptr(pn_connection_t *connection)
Associate a pn_connection_t with its pn_connection_driver_t.
pn_bytes_t pn_connection_driver_write_done(pn_connection_driver_t *, size_t n)
Call when the first n bytes of pn_connection_driver_write_buffer() have been written to IO.
void pn_connection_driver_read_done(pn_connection_driver_t *, size_t n)
Process the first n bytes of data in pn_connection_driver_read_buffer() and reclaim the buffer space.
void pn_connection_driver_vlogf(pn_connection_driver_t *d, const char *fmt, va_list ap)
Deprecated - Use pn_transport_vlogf().
void pn_connection_driver_close(pn_connection_driver_t *c)
Close both sides.
int pn_connection_driver_bind(pn_connection_driver_t *d)
Force binding of the transport.
void pn_connection_driver_verrorf(pn_connection_driver_t *d, const char *name, const char *fmt, va_list)
Set transport error via a va_list, see pn_connection_driver_errorf()
void pn_connection_driver_log(pn_connection_driver_t *d, const char *msg)
Deprecated - Use pn_transport_log().
bool pn_connection_driver_has_event(pn_connection_driver_t *)
True if pn_connection_driver_next_event() will return a non-NULL event.
void pn_connection_driver_write_close(pn_connection_driver_t *)
Close the write side.
The elements needed to drive AMQP IO and events.
Definition: connection_driver.h:90
struct pn_connection_t pn_connection_t
An AMQP Connection object.
Definition: types.h:285
struct pn_event_t pn_event_t
Notification of a state change in the protocol engine.
Definition: event.h:75
struct pn_collector_t pn_collector_t
An event collector.
Definition: types.h:417
struct pn_transport_t pn_transport_t
A network channel supporting an AMQP connection.
Definition: types.h:435
AMQP and API data types.