Qpid Proton C API 0.40.0
 
Loading...
Searching...
No Matches
transport.h
Go to the documentation of this file.
1#ifndef PROTON_TRANSPORT_H
2#define PROTON_TRANSPORT_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/annotations.h>
26#include <proton/import_export.h>
27#include <proton/type_compat.h>
28#include <proton/condition.h>
29#include <proton/logger.h>
30#include <stddef.h>
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
60typedef int pn_trace_t;
61
67typedef void (*pn_tracer_t)(pn_transport_t *transport, const char *message);
68
74#define PN_TRACE_OFF (0)
75
81#define PN_TRACE_RAW (1)
82
88#define PN_TRACE_FRM (2)
89
96#define PN_TRACE_DRV (4)
97
103#define PN_TRACE_EVT (8)
104
127
133PN_EXTERN void pn_transport_set_server(pn_transport_t *transport);
134
143PN_EXTERN void pn_transport_free(pn_transport_t *transport);
144
163PN_EXTERN const char *pn_transport_get_user(pn_transport_t *transport);
164
179PN_EXTERN void pn_transport_require_auth(pn_transport_t *transport, bool required);
180
191
204PN_EXTERN void pn_transport_require_encryption(pn_transport_t *transport, bool required);
205
215PN_EXTERN bool pn_transport_is_encrypted(pn_transport_t *transport);
216
230
243
248
256PN_EXTERN int pn_transport_bind(pn_transport_t *transport, pn_connection_t *connection);
257
265PN_EXTERN int pn_transport_unbind(pn_transport_t *transport);
266
278PN_EXTERN void pn_transport_trace(pn_transport_t *transport, pn_trace_t trace);
279
292PN_EXTERN void pn_transport_set_tracer(pn_transport_t *transport, pn_tracer_t tracer);
293
303
313PN_EXTERN void *pn_transport_get_context(pn_transport_t *transport);
314
324PN_EXTERN void pn_transport_set_context(pn_transport_t *transport, void *context);
325
333
345PN_EXTERN void pn_transport_log(pn_transport_t *transport, const char *message);
346
360PN_EXTERN void pn_transport_vlogf(pn_transport_t *transport, const char *fmt, va_list ap);
361
374PN_EXTERN void pn_transport_logf(pn_transport_t *transport, PN_PRINTF_FORMAT const char *fmt, ...)
375 PN_PRINTF_FORMAT_ATTR(2, 3);
376
389PN_EXTERN uint16_t pn_transport_get_channel_max(pn_transport_t *transport);
390
410PN_EXTERN int pn_transport_set_channel_max(pn_transport_t *transport, uint16_t channel_max);
411
420PN_EXTERN uint16_t pn_transport_remote_channel_max(pn_transport_t *transport);
421
430PN_EXTERN uint32_t pn_transport_get_max_frame(pn_transport_t *transport);
431
446PN_EXTERN void pn_transport_set_max_frame(pn_transport_t *transport, uint32_t size);
447
457
469
480PN_EXTERN void pn_transport_set_idle_timeout(pn_transport_t *transport, pn_millis_t timeout);
481
493
497PN_EXTERN ssize_t pn_transport_input(pn_transport_t *transport, const char *bytes, size_t available);
498
502PN_EXTERN ssize_t pn_transport_output(pn_transport_t *transport, char *bytes, size_t size);
503
521PN_EXTERN ssize_t pn_transport_capacity(pn_transport_t *transport);
522
535PN_EXTERN char *pn_transport_tail(pn_transport_t *transport);
536
554PN_EXTERN ssize_t pn_transport_push(pn_transport_t *transport, const char *src, size_t size);
555
571PN_EXTERN int pn_transport_process(pn_transport_t *transport, size_t size);
572
583PN_EXTERN int pn_transport_close_tail(pn_transport_t *transport);
584
601PN_EXTERN ssize_t pn_transport_pending(pn_transport_t *transport);
602
617PN_EXTERN const char *pn_transport_head(pn_transport_t *transport);
618
633PN_EXTERN ssize_t pn_transport_peek(pn_transport_t *transport, char *dst, size_t size);
634
648PN_EXTERN void pn_transport_pop(pn_transport_t *transport, size_t size);
649
660PN_EXTERN int pn_transport_close_head(pn_transport_t *transport);
661
670PN_EXTERN bool pn_transport_quiesced(pn_transport_t *transport);
671
677PN_EXTERN bool pn_transport_head_closed(pn_transport_t *transport);
678
684PN_EXTERN bool pn_transport_tail_closed(pn_transport_t *transport);
685
691PN_EXTERN bool pn_transport_closed(pn_transport_t *transport);
692
715PN_EXTERN int64_t pn_transport_tick(pn_transport_t *transport, int64_t now);
716
725PN_EXTERN uint64_t pn_transport_get_frames_output(const pn_transport_t *transport);
726
735PN_EXTERN uint64_t pn_transport_get_frames_input(const pn_transport_t *transport);
736
745
746#ifdef __cplusplus
747}
748#endif
749
754#endif /* transport.h */
An endpoint error state.
uint32_t pn_millis_t
A span of time in milliseconds.
Definition types.h:156
struct pn_condition_t pn_condition_t
An AMQP Condition object.
Definition condition.h:65
struct pn_connection_t pn_connection_t
An AMQP Connection object.
Definition types.h:300
struct pn_error_t pn_error_t
An int error code and some string text to describe the error.
Definition error.h:45
struct pn_logger_t pn_logger_t
The logger object allows library logging to be controlled.
Definition logger.h:86
pn_logger_t * pn_transport_logger(pn_transport_t *transport)
Get the transport logger.
ssize_t pn_transport_peek(pn_transport_t *transport, char *dst, size_t size)
Deprecated - Use the Connection driver API.
void * pn_transport_get_context(pn_transport_t *transport)
Get the application context that is associated with a transport object.
int pn_transport_bind(pn_transport_t *transport, pn_connection_t *connection)
Deprecated - Use pn_connection_driver_init().
int pn_transport_process(pn_transport_t *transport, size_t size)
Deprecated - Use the Connection driver API.
void pn_transport_require_auth(pn_transport_t *transport, bool required)
Set whether a non-authenticated transport connection is allowed.
void uint16_t pn_transport_get_channel_max(pn_transport_t *transport)
Get the maximum allowed channel for a transport.
pn_transport_t * pn_transport(void)
Factory for creating a transport.
int pn_transport_unbind(pn_transport_t *transport)
Deprecated - Use pn_connection_driver_destroy().
pn_tracer_t pn_transport_get_tracer(pn_transport_t *transport)
Get the tracing function used by a transport.
void pn_transport_logf(pn_transport_t *transport, PN_PRINTF_FORMAT const char *fmt,...) PN_PRINTF_FORMAT_ATTR(2
Log a printf formatted message using a transport's logging mechanism.
void pn_transport_pop(pn_transport_t *transport, size_t size)
Deprecated - Use the Connection driver API.
uint32_t pn_transport_get_remote_max_frame(pn_transport_t *transport)
Get the maximum frame size of a transport's remote peer.
uint64_t pn_transport_get_frames_output(const pn_transport_t *transport)
Deprecated - No replacement.
bool pn_transport_head_closed(pn_transport_t *transport)
Deprecated - Use the Connection driver API.
uint32_t pn_transport_get_max_frame(pn_transport_t *transport)
Get the maximum frame size of a transport.
int pn_trace_t
Holds the trace flags for an AMQP transport.
Definition transport.h:60
ssize_t pn_transport_push(pn_transport_t *transport, const char *src, size_t size)
Deprecated - Use the Connection driver API.
void pn_transport_set_max_frame(pn_transport_t *transport, uint32_t size)
Set the maximum frame size of a transport.
bool pn_transport_closed(pn_transport_t *transport)
Deprecated - Use the Connection driver API.
pn_connection_t * pn_transport_connection(pn_transport_t *transport)
Access the AMQP Connection associated with the transport.
bool pn_transport_tail_closed(pn_transport_t *transport)
Deprecated - Use the Connection driver API.
pn_millis_t pn_transport_get_idle_timeout(pn_transport_t *transport)
Get the idle timeout for a transport.
void pn_transport_free(pn_transport_t *transport)
Free a transport object.
bool pn_transport_is_encrypted(pn_transport_t *transport)
Tell whether the transport connection is encrypted.
void pn_transport_set_tracer(pn_transport_t *transport, pn_tracer_t tracer)
Set the tracing function used by a transport.
ssize_t pn_transport_pending(pn_transport_t *transport)
Deprecated - Use the Connection driver API.
const char * pn_transport_get_user(pn_transport_t *transport)
Retrieve the authenticated user.
bool pn_transport_is_authenticated(pn_transport_t *transport)
Tell whether the transport connection is authenticated.
int64_t pn_transport_tick(pn_transport_t *transport, int64_t now)
Process any pending transport timer events.
int pn_transport_set_channel_max(pn_transport_t *transport, uint16_t channel_max)
Set the maximum allowed channel number for a transport.
uint64_t pn_transport_get_frames_input(const pn_transport_t *transport)
Deprecated - No replacement.
ssize_t pn_transport_input(pn_transport_t *transport, const char *bytes, size_t available)
Deprecated - Use the Connection driver API.
const char * pn_transport_head(pn_transport_t *transport)
Deprecated - Use the Connection driver API.
ssize_t pn_transport_capacity(pn_transport_t *transport)
Deprecated - Use the Connection driver API.
int pn_transport_close_tail(pn_transport_t *transport)
Deprecated - Use the Connection driver API.
void pn_transport_trace(pn_transport_t *transport, pn_trace_t trace)
Update a transports trace flags.
int pn_transport_close_head(pn_transport_t *transport)
Deprecated - Use the Connection driver API.
bool pn_transport_quiesced(pn_transport_t *transport)
Deprecated - Use the Connection driver API.
pn_millis_t pn_transport_get_remote_idle_timeout(pn_transport_t *transport)
Get the idle timeout for a transport's remote peer.
void pn_transport_set_context(pn_transport_t *transport, void *context)
Set a new application context for a transport object.
struct pn_transport_t pn_transport_t
A network channel supporting an AMQP connection.
Definition types.h:450
void pn_transport_set_server(pn_transport_t *transport)
Configure a transport as a server.
void pn_transport_vlogf(pn_transport_t *transport, const char *fmt, va_list ap)
Log a printf formatted message using a transport's logging mechanism.
void pn_transport_log(pn_transport_t *transport, const char *message)
Log a message using a transport's logging mechanism.
pn_error_t * pn_transport_error(pn_transport_t *transport)
Deprecated - Use pn_transport_condition().
char * pn_transport_tail(pn_transport_t *transport)
Deprecated - Use the Connection driver API.
ssize_t pn_transport_output(pn_transport_t *transport, char *bytes, size_t size)
Deprecated - Use the Connection driver API.
void(* pn_tracer_t)(pn_transport_t *transport, const char *message)
Callback for customizing logging behaviour.
Definition transport.h:67
void pn_transport_require_encryption(pn_transport_t *transport, bool required)
Set whether a non encrypted transport connection is allowed.
void pn_transport_set_idle_timeout(pn_transport_t *transport, pn_millis_t timeout)
Set the idle timeout for a transport.
pn_condition_t * pn_transport_condition(pn_transport_t *transport)
Get additional information about the condition of the transport.
pn_record_t * pn_transport_attachments(pn_transport_t *transport)
Get the attachments that are associated with a transport object.
uint16_t pn_transport_remote_channel_max(pn_transport_t *transport)
Get the maximum allowed channel of a transport's remote peer.
Facility for logging messages.
struct pn_record_t pn_record_t
A type representing attached context information.
Definition types.h:492