1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
#ifndef __dispatch_iterator_h__
#define __dispatch_iterator_h__ 1
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#include <stdint.h>
#include <qpid/dispatch/buffer.h>
#include <qpid/dispatch/iovec.h>
/**
* The field iterator is used to access fields within a buffer chain.
* It shields the user from the fact that the field may be split across
* one or more physical buffers.
*/
typedef struct dx_field_iterator_t dx_field_iterator_t;
/**
* Iterator views allow the code traversing the field to see a transformed
* view of the raw field.
*
* ITER_VIEW_ALL - No transformation of the raw field data
*
* ITER_VIEW_NO_HOST - Remove the scheme and host fields from the view
*
* amqp://host.domain.com:port/node-id/node/specific
* ^^^^^^^^^^^^^^^^^^^^^
* node-id/node/specific
* ^^^^^^^^^^^^^^^^^^^^^
*
* ITER_VIEW_NODE_ID - Isolate the node identifier from an address
*
* amqp://host.domain.com:port/node-id/node/specific
* ^^^^^^^
* node-id/node/specific
* ^^^^^^^
*
* ITER_VIEW_NODE_SPECIFIC - Isolate node-specific text from an address
*
* amqp://host.domain.com:port/node-id/node/specific
* ^^^^^^^^^^^^^
* node-id/node/specific
* ^^^^^^^^^^^^^
*
* ITER_VIEW_ADDRESS_HASH - Isolate the hashable part of the address depending on address syntax
*
* amqp:/_local/<local>
* L^^^^^^^
* amqp:/_topo/<area>/<router>/<local>
* A^^^^^^
* amqp:/_topo/<my-area>/<router>/<local>
* R^^^^^^^^
* amqp:/_topo/<my_area>/<my-router>/<local>
* L^^^^^^^
* amqp:/_topo/<area>/all/<local>
* A^^^^^^
* amqp:/_topo/<my-area>/all/<local>
* L^^^^^^^
* amqp:/_topo/all/all/<local>
* L^^^^^^^
* amqp:/<mobile>
* M^^^^^^^^
*
*/
typedef enum {
ITER_VIEW_ALL,
ITER_VIEW_NO_HOST,
ITER_VIEW_NODE_ID,
ITER_VIEW_NODE_SPECIFIC,
ITER_VIEW_ADDRESS_HASH
} dx_iterator_view_t;
/**
* Set the area and router names for the local router. These are used to match
* my-area and my-router in address fields.
*/
void dx_field_iterator_set_address(const char *area, const char *router);
/**
* Create an iterator from a null-terminated string.
*
* The "text" string must stay intact for the whole life of the iterator. The iterator
* does not copy the string, it references it.
*/
dx_field_iterator_t* dx_field_iterator_string(const char *text,
dx_iterator_view_t view);
dx_field_iterator_t* dx_field_iterator_binary(const char *text,
int length,
dx_iterator_view_t view);
/**
* Create an iterator from a field in a buffer chain
*/
dx_field_iterator_t *dx_field_iterator_buffer(dx_buffer_t *buffer,
int offset,
int length,
dx_iterator_view_t view);
/**
* Free an iterator
*/
void dx_field_iterator_free(dx_field_iterator_t *iter);
/**
* Reset the iterator to the first octet and set a new view
*/
void dx_field_iterator_reset(dx_field_iterator_t *iter);
void dx_field_iterator_reset_view(dx_field_iterator_t *iter,
dx_iterator_view_t view);
/**
* Return the current octet in the iterator's view and step to the next.
*/
unsigned char dx_field_iterator_octet(dx_field_iterator_t *iter);
/**
* Return true iff the iterator has no more octets in the view.
*/
int dx_field_iterator_end(dx_field_iterator_t *iter);
/**
* Return a sub-iterator that equals the supplied iterator except that it
* starts at the supplied iterator's current position.
*/
dx_field_iterator_t *dx_field_iterator_sub(dx_field_iterator_t *iter, uint32_t length);
void dx_field_iterator_advance(dx_field_iterator_t *iter, uint32_t length);
/**
* Compare an input string to the iterator's view. Return true iff they are equal.
*/
int dx_field_iterator_equal(dx_field_iterator_t *iter, const unsigned char *string);
/**
* Return true iff the string matches the characters at the current location in the view.
* This function ignores octets beyond the length of the prefix.
* This function does not alter the position of the iterator if the prefix does not match,
* if it matches, the prefix is consumed.
*/
int dx_field_iterator_prefix(dx_field_iterator_t *iter, const char *prefix);
/**
* Return a copy of the iterator's view.
*/
unsigned char *dx_field_iterator_copy(dx_field_iterator_t *iter);
/**
* Return the contents of this iter into an iovec structure. This is used in a
* scatter/gather IO mechanism. If the iterator spans multiple physical buffers,
* the iovec structure will contain one pointer per buffer.
*
* @param iter A field iterator
* @return An iovec structure that references the data in the iterator's buffers.
*/
dx_iovec_t *dx_field_iterator_iovec(const dx_field_iterator_t *iter);
#endif
|
