session: segment handle in accept/connect notifications

[vpp.git] / src / vnet / session / session.api

diff --git a/src/vnet/session/session.api b/src/vnet/session/session.api
index 24ebfba..3dc0cc8 100644 (file)
--- a/src/vnet/session/session.api
+++ b/src/vnet/session/session.api
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-option version = "1.2.0";
+option version = "1.4.0";
 
 /** \brief client->vpp, attach application to session layer
     @param client_index - opaque cookie to identify the sender
@@ -44,6 +44,7 @@ option version = "1.2.0";
     @param segment_size - size of first shm segment
     @param segment_name_length - length of segment name 
     @param segment_name - name of segment client needs to attach to
+    @param app_index - index of the newly created app
 */
 define application_attach_reply {
     u32 context;
@@ -54,6 +55,7 @@ define application_attach_reply {
     u32 segment_size;
     u8 segment_name_length;
     u8 segment_name[128];
+    u32 app_index;
 };
 
 /** \brief Application add TLS certificate
@@ -101,6 +103,7 @@ autoreply define application_detach {
                                          socket transport available
     @param segment_size - size of the segment to be mapped
     @param segment_name - name of the segment to be mapped
+    @param segment_handle - unique identifier for segment
 */
 autoreply define map_another_segment {
     u32 client_index;
@@ -108,17 +111,19 @@ autoreply define map_another_segment {
     u8 fd_flags;
     u32 segment_size;
     u8 segment_name[128];
+    u64 segment_handle;
 };
 
 /** \brief vpp->client unmap shared memory segment
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param segment_name - 
+    @param segment_name - segment name
+    @param segment_handle - handle of the segment to be unmapped 
 */
 autoreply define unmap_segment {
     u32 client_index;
     u32 context;
-    u8 segment_name[128];
+    u64 segment_handle;
 };
 
  /** \brief Bind to a given URI
@@ -135,7 +140,7 @@ define bind_uri {
   u32 accept_cookie;
   u8 uri[128];
 };
-
+/** *** Will be DEPRECATED. Use message queue instead. *** */
 define bind_uri_reply {
   u32 context;
   u64 handle;
@@ -180,6 +185,7 @@ autoreply define connect_uri {
 };
 
 /** \brief vpp->client, accept this session
+       *** Will be DEPRECATED. Use message queue instead. ***
     @param context - sender context, to match reply w/ request
     @param listener_handle - tells client which listener this pertains to
     @param handle - unique session identifier
@@ -208,6 +214,7 @@ define accept_session {
 };
 
 /** \brief client->vpp, reply to an accept message
+       *** Will be DEPRECATED. Use message queue instead. ***
     @param context - sender context, to match reply w/ request
     @param retval - return code for the request
     @param session_index - session index from accept_session / connect_reply
@@ -233,6 +240,7 @@ define disconnect_session {
 };
 
 /** \brief bidirectional disconnect reply API
+       *** Will be DEPRECATED. Use message queue instead. ***
     @param client_index - opaque cookie to identify the sender
                           client to vpp direction only
     @param context - sender context, to match reply w/ request
@@ -246,6 +254,7 @@ define disconnect_session_reply {
 };
 
 /** \brief vpp->client reset session API
+       *** Will be DEPRECATED. Use message queue instead. ***
     @param client_index - opaque cookie to identify the sender
                           client to vpp direction only
     @param context - sender context, to match reply w/ request
@@ -258,6 +267,7 @@ define reset_session {
 };
 
 /** \brief client->vpp reset session reply
+       *** Will be DEPRECATED. Use message queue instead. ***
     @param context - sender context, to match reply w/ request
     @param retval - return code for the request
     @param handle - session handle obtained via accept/connect
@@ -294,11 +304,13 @@ define bind_sock {
 /** \brief Unbind 
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
+    @param wrk_index - index of worker requesting the bind
     @param handle - bind handle obtained from bind reply
 */
 autoreply define unbind_sock {
   u32 client_index;
   u32 context;
+  u32 wrk_index;
   u64 handle;
 };
 
@@ -334,6 +346,7 @@ autoreply define connect_sock {
 };
 
 /** \brief Bind reply
+       *** Will be DEPRECATED. Use message queue instead. ***
     @param context - sender context, to match reply w/ request
     @param handle - bind handle
     @param retval - return code for the request
@@ -371,6 +384,7 @@ define connect_session {
 };
 
 /** \brief vpp/server->client, connect reply -- used for all connect_* messages
+       *** Will be DEPRECATED. Use message queue instead. ***
     @param context - sender context, to match reply w/ request
     @param retval - return code for the request
     @param handle - connection handle
@@ -428,7 +442,7 @@ autoreply define app_cut_through_registration_add
     @param client_index - opaque cookie to identify the sender
                           client to vpp direction only
     @param context - sender context, to match reply w/ request
-    @param app_api_index - explicit client api index
+    @param app_index - application index
     @param wrk_index - worker index, if a delete
     @param is_add - set if an add
 */
@@ -436,7 +450,7 @@ define app_worker_add_del
 {
   u32 client_index;
   u32 context;
-  u32 app_api_index;
+  u32 app_index;
   u32 wrk_index;
   u8 is_add;
 };
@@ -451,6 +465,7 @@ define app_worker_add_del
                                  over the socket (set only if socket transport available) 
     @param segment_name_length - length of segment name 
     @param segment_name - name of segment client needs to attach to
+    @param segment_handle - handle for segment
 */
 define app_worker_add_del_reply
 {
@@ -462,6 +477,7 @@ define app_worker_add_del_reply
   u8 fd_flags;
   u8 segment_name_length;
   u8 segment_name[128];
+  u64 segment_handle;
   u8 is_add;
 };