Qpid Proton C API 0.39.0
 
Loading...
Searching...
No Matches
raw_connection.h
Go to the documentation of this file.
1#ifndef PROTON_RAW_CONNECTION_H
2#define PROTON_RAW_CONNECTION_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
23#include <proton/condition.h>
24#include <proton/event.h>
25#include <proton/import_export.h>
26#include <proton/types.h>
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
54typedef struct pn_raw_buffer_t {
55 uintptr_t context;
56 char *bytes;
57 uint32_t capacity;
58 uint32_t size;
59 uint32_t offset;
61
62
79
85
91
103PNP_EXTERN void pn_raw_connection_close(pn_raw_connection_t *connection);
104
120
136
141
146
170PNP_EXTERN size_t pn_raw_connection_give_read_buffers(pn_raw_connection_t *connection, pn_raw_buffer_t const *buffers, size_t num);
171
188PNP_EXTERN size_t pn_raw_connection_take_read_buffers(pn_raw_connection_t *connection, pn_raw_buffer_t *buffers, size_t num);
189
210PNP_EXTERN size_t pn_raw_connection_write_buffers(pn_raw_connection_t *connection, pn_raw_buffer_t const *buffers, size_t num);
211
227PNP_EXTERN size_t pn_raw_connection_take_written_buffers(pn_raw_connection_t *connection, pn_raw_buffer_t *buffers, size_t num);
228
235
242
262PNP_EXTERN void pn_raw_connection_wake(pn_raw_connection_t *connection);
263
273
284
294PNP_EXTERN void pn_raw_connection_set_context(pn_raw_connection_t *connection, void *context);
295
300
307
317
322#ifdef __cplusplus
323}
324#endif
325
326#endif /* raw_connection.h */
An endpoint error state.
Protocol and transport events.
struct pn_condition_t pn_condition_t
An AMQP Condition object.
Definition: condition.h:64
struct pn_event_t pn_event_t
Notification of a state change in the protocol engine.
Definition: event.h:75
struct pn_event_batch_t pn_event_batch_t
A batch of events that must be handled in sequence.
Definition: types.h:462
struct pn_netaddr_t pn_netaddr_t
Unsettled API - The network address of a proactor transport.
Definition: netaddr.h:42
uint32_t capacity
Count of available bytes starting at bytes.
Definition: raw_connection.h:57
uint32_t offset
First byte in the buffer to be read or written.
Definition: raw_connection.h:59
uint32_t size
Number of bytes read or to be written starting at offset.
Definition: raw_connection.h:58
char * bytes
Pointer to the start of the raw buffer, if this is null then no buffer is represented.
Definition: raw_connection.h:56
uintptr_t context
Used to associate arbitrary application data with this raw buffer.
Definition: raw_connection.h:55
PNP_EXTERN void * pn_raw_connection_get_context(pn_raw_connection_t *connection)
Get the application context associated with this raw connection.
PNP_EXTERN size_t pn_raw_connection_read_buffers_capacity(pn_raw_connection_t *connection)
Query the raw connection for how many more read buffers it can be given.
PNP_EXTERN size_t pn_raw_connection_write_buffers(pn_raw_connection_t *connection, pn_raw_buffer_t const *buffers, size_t num)
Give the raw connection buffers to write to the underlying socket.
PNP_EXTERN size_t pn_raw_connection_take_written_buffers(pn_raw_connection_t *connection, pn_raw_buffer_t *buffers, size_t num)
Return a buffer chain with buffers that have all been written to the raw socket.
PNP_EXTERN const struct pn_netaddr_t * pn_raw_connection_local_addr(pn_raw_connection_t *connection)
Get the local address of a raw connection.
struct pn_raw_connection_t pn_raw_connection_t
A raw network connection used with the proactor.
Definition: types.h:449
PNP_EXTERN pn_record_t * pn_raw_connection_attachments(pn_raw_connection_t *connection)
Get the attachments that are associated with a raw connection.
PNP_EXTERN pn_raw_connection_t * pn_event_raw_connection(pn_event_t *event)
Return the raw connection associated with an event.
PNP_EXTERN pn_raw_connection_t * pn_raw_connection(void)
Create a new raw connection for use with the Proactor.
PNP_EXTERN void pn_raw_connection_read_close(pn_raw_connection_t *connection)
Shutdown a raw connection for reading.
PNP_EXTERN pn_condition_t * pn_raw_connection_condition(pn_raw_connection_t *connection)
Get additional information about a raw connection error.
PNP_EXTERN size_t pn_raw_connection_write_buffers_capacity(pn_raw_connection_t *connection)
Query the raw connection for how many more write buffers it can be given.
PNP_EXTERN void pn_raw_connection_wake(pn_raw_connection_t *connection)
Return a PN_RAW_CONNECTION_WAKE event for connection as soon as possible.
PNP_EXTERN size_t pn_raw_connection_give_read_buffers(pn_raw_connection_t *connection, pn_raw_buffer_t const *buffers, size_t num)
Give the raw connection buffers to use for reading from the underlying socket.
PNP_EXTERN void pn_raw_connection_close(pn_raw_connection_t *connection)
Close a raw connection.
PNP_EXTERN size_t pn_raw_connection_take_read_buffers(pn_raw_connection_t *connection, pn_raw_buffer_t *buffers, size_t num)
Fetch buffers with bytes read from the raw socket.
PNP_EXTERN bool pn_raw_connection_is_read_closed(pn_raw_connection_t *connection)
Is connection closed for read?
PNP_EXTERN bool pn_raw_connection_is_write_closed(pn_raw_connection_t *connection)
Is connection closed for write?
PNP_EXTERN pn_raw_connection_t * pn_event_batch_raw_connection(pn_event_batch_t *batch)
Query the batch for the subject of the batch.
PNP_EXTERN void pn_raw_connection_write_close(pn_raw_connection_t *connection)
Shutdown a raw connection for writing.
PNP_EXTERN void pn_raw_connection_set_context(pn_raw_connection_t *connection, void *context)
Set a new application context for a raw connection.
PNP_EXTERN const struct pn_netaddr_t * pn_raw_connection_remote_addr(pn_raw_connection_t *connection)
Get the local address of a raw connection.
A descriptor used to represent a single raw buffer in memory.
Definition: raw_connection.h:54
AMQP and API data types.
struct pn_record_t pn_record_t
A type representing attached context information.
Definition: types.h:477