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 */
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
84 session_endpoint_t sep;
88 /* Used for redirects */
90 session_handle_t session_handle;
91 } vnet_connect_args_t;
93 typedef struct _vnet_disconnect_args_t
95 session_handle_t handle;
97 } vnet_disconnect_args_t;
99 /* Application attach options */
103 APP_OPTIONS_EVT_QUEUE_SIZE,
104 APP_OPTIONS_SEGMENT_SIZE,
105 APP_OPTIONS_ADD_SEGMENT_SIZE,
106 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
107 APP_OPTIONS_RX_FIFO_SIZE,
108 APP_OPTIONS_TX_FIFO_SIZE,
109 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
110 APP_OPTIONS_NAMESPACE,
111 APP_OPTIONS_NAMESPACE_SECRET,
112 APP_OPTIONS_PROXY_TRANSPORT,
113 APP_OPTIONS_ACCEPT_COOKIE,
114 APP_OPTIONS_N_OPTIONS
115 } app_attach_options_index_t;
117 #define foreach_app_options_flags \
118 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
119 _(ADD_SEGMENT, "Add segment and signal app if needed") \
120 _(IS_BUILTIN, "Application is builtin") \
121 _(IS_PROXY, "Application is proxying") \
122 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
123 _(USE_LOCAL_SCOPE, "App can use local session scope")
125 typedef enum _app_options
127 #define _(sym, str) APP_OPTIONS_##sym,
128 foreach_app_options_flags
132 typedef enum _app_options_flags
134 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
135 foreach_app_options_flags
137 } app_options_flags_t;
139 clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
140 int vnet_application_detach (vnet_app_detach_args_t * a);
142 int vnet_bind_uri (vnet_bind_args_t *);
143 int vnet_unbind_uri (vnet_unbind_args_t * a);
144 clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
145 int vnet_disconnect_session (vnet_disconnect_args_t * a);
147 clib_error_t *vnet_bind (vnet_bind_args_t * a);
148 clib_error_t *vnet_connect (vnet_connect_args_t * a);
149 clib_error_t *vnet_unbind (vnet_unbind_args_t * a);
152 api_parse_session_handle (u64 handle, u32 * session_index,
155 void send_local_session_disconnect_callback (u32 app_index,
156 local_session_t * ls);
158 #endif /* __included_uri_h__ */
161 * fd.io coding-style-patch-verification: ON
164 * eval: (c-set-style "gnu")