2 * Copyright (c) 2017 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.
16 #ifndef SRC_VNET_SESSION_APPLICATION_H_
17 #define SRC_VNET_SESSION_APPLICATION_H_
19 #include <vnet/vnet.h>
20 #include <vnet/session/session.h>
21 #include <vnet/session/segment_manager.h>
22 #include <vnet/session/application_namespace.h>
30 typedef struct _stream_session_cb_vft
32 /** Notify server of new segment */
33 int (*add_segment_callback) (u32 api_client_index, const u8 * seg_name,
36 /** Notify server of newly accepted session */
37 int (*session_accept_callback) (stream_session_t * new_session);
39 /** Connection request callback */
40 int (*session_connected_callback) (u32 app_index, u32 opaque,
41 stream_session_t * s, u8 code);
43 /** Notify app that session is closing */
44 void (*session_disconnect_callback) (stream_session_t * s);
46 /** Notify app that session was reset */
47 void (*session_reset_callback) (stream_session_t * s);
49 /** Direct RX callback, for built-in servers */
50 int (*builtin_server_rx_callback) (stream_session_t * session);
52 /** Redirect connection to local server */
53 int (*redirect_connect_callback) (u32 api_client_index, void *mp);
56 typedef struct _application
58 /** Index in server pool */
65 * Binary API interface to external app
68 /** Binary API connection index, ~0 if internal */
71 /** Namespace the application belongs to */
74 /** Application listens for events on this svm queue */
75 svm_queue_t *event_queue;
78 * Callbacks: shoulder-taps for the server/client
81 session_cb_vft_t cb_fns;
84 * svm segment management
86 u32 connects_seg_manager;
88 /** Lookup tables for listeners. Value is segment manager index */
89 uword *listeners_table;
92 * First segment manager has in the the first segment the application's
93 * event fifo. Depending on what the app does, it may be either used for
94 * a listener or for connects.
96 u32 first_segment_manager;
97 u8 first_segment_manager_in_use;
99 /** Segment manager properties. Shared by all segment managers */
102 u16 proxied_transports;
105 #define APP_INVALID_INDEX ((u32)~0)
106 #define APP_DROP_INDEX (((u32)~0) - 1)
107 #define APP_NS_INVALID_INDEX ((u32)~0)
108 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
110 application_t *application_new ();
111 int application_init (application_t * app, u32 api_client_index,
112 u64 * options, session_cb_vft_t * cb_fns);
113 void application_del (application_t * app);
114 application_t *application_get (u32 index);
115 application_t *application_get_if_valid (u32 index);
116 application_t *application_lookup (u32 api_client_index);
117 u32 application_get_index (application_t * app);
119 int application_start_listen (application_t * app,
120 session_endpoint_t * tep, u64 * handle);
121 int application_stop_listen (application_t * srv, u64 handle);
122 int application_open_session (application_t * app, session_endpoint_t * tep,
124 int application_api_queue_is_full (application_t * app);
126 segment_manager_t *application_get_listen_segment_manager (application_t *
130 segment_manager_t *application_get_connect_segment_manager (application_t *
132 int application_is_proxy (application_t * app);
133 int application_is_builtin (application_t * app);
134 int application_is_builtin_proxy (application_t * app);
135 int application_add_segment_notify (u32 app_index, u32 fifo_segment_index);
136 u32 application_session_table (application_t * app, u8 fib_proto);
137 u32 application_local_session_table (application_t * app);
138 u8 *application_name_from_index (u32 app_index);
140 u8 application_has_local_scope (application_t * app);
141 u8 application_has_global_scope (application_t * app);
142 u32 application_n_listeners (application_t * app);
143 stream_session_t *application_first_listener (application_t * app,
146 void application_setup_proxy (application_t * app);
147 void application_remove_proxy (application_t * app);
149 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
152 * fd.io coding-style-patch-verification: ON
155 * eval: (c-set-style "gnu")