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 struct _vnet_app_attach_args_t
27 /** Binary API client index */
30 /** Application and segment manager options */
33 /** ID of the namespace the app has access to */
36 /** Session to application callback functions */
37 session_cb_vft_t *session_cb_vft;
42 ssvm_private_t *segment;
43 u64 app_event_queue_address;
45 } vnet_app_attach_args_t;
47 typedef struct _vnet_app_detach_args_t
50 } vnet_app_detach_args_t;
52 typedef struct _vnet_bind_args_t
57 session_endpoint_t sep;
66 u32 segment_name_length;
67 u64 server_event_queue_address;
71 typedef struct _vnet_unbind_args_t
81 typedef struct _vnet_connect_args
86 session_endpoint_t sep;
91 /* Used for redirects */
93 session_handle_t session_handle;
94 } vnet_connect_args_t;
96 typedef struct _vnet_disconnect_args_t
98 session_handle_t handle;
100 } vnet_disconnect_args_t;
102 typedef struct _vnet_application_add_tls_cert_args_t
106 } vnet_app_add_tls_cert_args_t;
108 typedef struct _vnet_application_add_tls_key_args_t
112 } vnet_app_add_tls_key_args_t;
114 /* Application attach options */
118 APP_OPTIONS_EVT_QUEUE_SIZE,
119 APP_OPTIONS_SEGMENT_SIZE,
120 APP_OPTIONS_ADD_SEGMENT_SIZE,
121 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
122 APP_OPTIONS_RX_FIFO_SIZE,
123 APP_OPTIONS_TX_FIFO_SIZE,
124 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
125 APP_OPTIONS_NAMESPACE,
126 APP_OPTIONS_NAMESPACE_SECRET,
127 APP_OPTIONS_PROXY_TRANSPORT,
128 APP_OPTIONS_ACCEPT_COOKIE,
129 APP_OPTIONS_N_OPTIONS
130 } app_attach_options_index_t;
132 #define foreach_app_options_flags \
133 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
134 _(ADD_SEGMENT, "Add segment and signal app if needed") \
135 _(IS_BUILTIN, "Application is builtin") \
136 _(IS_PROXY, "Application is proxying") \
137 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
138 _(USE_LOCAL_SCOPE, "App can use local session scope")
140 typedef enum _app_options
142 #define _(sym, str) APP_OPTIONS_##sym,
143 foreach_app_options_flags
147 typedef enum _app_options_flags
149 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
150 foreach_app_options_flags
152 } app_options_flags_t;
154 int vnet_bind_uri (vnet_bind_args_t *);
155 int vnet_unbind_uri (vnet_unbind_args_t * a);
156 clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
158 clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
159 clib_error_t *vnet_bind (vnet_bind_args_t * a);
160 clib_error_t *vnet_connect (vnet_connect_args_t * a);
161 clib_error_t *vnet_unbind (vnet_unbind_args_t * a);
162 int vnet_application_detach (vnet_app_detach_args_t * a);
163 int vnet_disconnect_session (vnet_disconnect_args_t * a);
165 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
166 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
168 extern const char test_srv_crt_rsa[];
169 extern const u32 test_srv_crt_rsa_len;
170 extern const char test_srv_key_rsa[];
171 extern const u32 test_srv_key_rsa_len;
173 #endif /* __included_uri_h__ */
176 * fd.io coding-style-patch-verification: ON
179 * eval: (c-set-style "gnu")