2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #ifndef __included_uri_h__
16 #define __included_uri_h__
18 #include <vlib/vlib.h>
19 #include <vnet/vnet.h>
20 #include <svm/svm_fifo_segment.h>
21 #include <vnet/session/session.h>
22 #include <vnet/session/application.h>
23 #include <vnet/session/transport.h>
25 typedef enum _session_api_proto
29 } session_api_proto_t;
31 typedef struct _vnet_app_attach_args_t
33 /** Binary API client index */
36 /** Application and segment manager options */
39 /** Session to application callback functions */
40 session_cb_vft_t *session_cb_vft;
42 /** Flag that indicates if app is builtin */
49 u32 segment_name_length;
51 u64 app_event_queue_address;
53 } vnet_app_attach_args_t;
55 typedef struct _vnet_app_detach_args_t
58 } vnet_app_detach_args_t;
60 typedef struct _vnet_bind_args_t
67 transport_endpoint_t tep;
68 session_api_proto_t proto;
78 u32 segment_name_length;
79 u64 server_event_queue_address;
83 typedef struct _vnet_unbind_args_t
93 typedef struct _vnet_connect_args
100 transport_endpoint_t tep;
101 session_api_proto_t proto;
107 /* Used for redirects */
109 } vnet_connect_args_t;
111 typedef struct _vnet_disconnect_args_t
115 } vnet_disconnect_args_t;
117 /* Application attach options */
122 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
123 SESSION_OPTIONS_SEGMENT_SIZE,
124 SESSION_OPTIONS_ADD_SEGMENT_SIZE,
125 SESSION_OPTIONS_RX_FIFO_SIZE,
126 SESSION_OPTIONS_TX_FIFO_SIZE,
127 SESSION_OPTIONS_PREALLOCATED_FIFO_PAIRS,
128 SESSION_OPTIONS_ACCEPT_COOKIE,
129 SESSION_OPTIONS_N_OPTIONS
130 } app_attach_options_index_t;
132 #define foreach_app_options_flags \
133 _(USE_FIFO, "Use FIFO with redirects") \
134 _(ADD_SEGMENT, "Add segment and signal app if needed") \
135 _(BUILTIN_APP, "Application is builtin") \
137 typedef enum _app_options
139 #define _(sym, str) APP_OPTIONS_##sym,
140 foreach_app_options_flags
144 typedef enum _app_options_flags
146 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
147 foreach_app_options_flags
149 } app_options_flags_t;
151 ///** Server can handle delegated connect requests from local clients */
152 //#define APP_OPTIONS_FLAGS_USE_FIFO (1<<0)
154 ///** Server wants vpp to add segments when out of memory for fifos */
155 //#define APP_OPTIONS_FLAGS_ADD_SEGMENT (1<<1)
157 #define VNET_CONNECT_REDIRECTED 123
159 int vnet_application_attach (vnet_app_attach_args_t * a);
160 int vnet_application_detach (vnet_app_detach_args_t * a);
162 int vnet_bind_uri (vnet_bind_args_t *);
163 int vnet_unbind_uri (vnet_unbind_args_t * a);
164 int vnet_connect_uri (vnet_connect_args_t * a);
165 int vnet_disconnect_session (vnet_disconnect_args_t * a);
167 int vnet_bind (vnet_bind_args_t * a);
168 int vnet_connect (vnet_connect_args_t * a);
169 int vnet_unbind (vnet_unbind_args_t * a);
172 api_parse_session_handle (u64 handle, u32 * session_index,
175 #endif /* __included_uri_h__ */
178 * fd.io coding-style-patch-verification: ON
181 * eval: (c-set-style "gnu")