session: mark apis for deprecation

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

diff --git a/src/vnet/session/session.api b/src/vnet/session/session.api
index c60e99e..64b8205 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.1.0";
+option version = "1.2.1";
 
 /** \brief client->vpp, attach application to session layer
     @param client_index - opaque cookie to identify the sender
@@ -135,7 +135,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 +180,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 +209,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 +235,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 +249,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 +262,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
@@ -271,6 +276,7 @@ define reset_session_reply {
 /** \brief Bind to an ip:port pair for a given transport protocol
     @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 vrf - bind namespace
     @param is_ip4 - flag that is 1 if ip address family is IPv4
     @param ip - ip address
@@ -281,6 +287,7 @@ define reset_session_reply {
 define bind_sock {
   u32 client_index;
   u32 context;
+  u32 wrk_index;
   u32 vrf;
   u8 is_ip4;
   u8 ip[16];
@@ -292,17 +299,20 @@ 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;
 };
 
 /** \brief Connect to a remote peer
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
+    @param wrk_index - worker that requests the connect
     @param client_queue_address - client's API queue address. Non-zero when 
                                   used to perform redirects
     @param options - socket options, fifo sizes, etc. when doing redirects
@@ -318,6 +328,7 @@ autoreply define unbind_sock {
 autoreply define connect_sock {
   u32 client_index;
   u32 context;
+  u32 wrk_index;
   u64 client_queue_address;
   u64 options[16];
   u32 vrf;
@@ -330,6 +341,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
@@ -367,6 +379,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
@@ -404,6 +417,7 @@ define connect_session_reply {
     @param context - sender context, to match reply w/ request
     @param evt_q_address - address of the mq in ssvm segment
     @param peer_evt_q_address - address of peer's mq in ssvm segment
+    @param wrk_index - index of worker to receive the registration
     @param n_fds - number of fds exchanged
     @param fd_flags - flag indicating the fds that will be exchanged over
                                  api socket
@@ -414,10 +428,52 @@ autoreply define app_cut_through_registration_add
   u32 context;
   u64 evt_q_address;
   u64 peer_evt_q_address;
+  u32 wrk_index;
   u8 n_fds;
   u8 fd_flags;
 };
 
+/** \brief add/del application worker
+    @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 wrk_index - worker index, if a delete
+    @param is_add - set if an add
+*/
+define app_worker_add_del
+{
+  u32 client_index;
+  u32 context;
+  u32 app_api_index;
+  u32 wrk_index;
+  u8 is_add;
+};
+
+/** \brief Reply for app worker add/del
+    @param context - returned sender context, to match reply w/ request
+    @param retval - return code
+    @param wrk_index - worker index, if add
+    @param app_event_queue_address - vpp event queue address of new worker
+    @param n_fds - number of fds exchanged
+    @param fd_flags - set of flags that indicate which fds are to be expected
+                                 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
+*/
+define app_worker_add_del_reply
+{
+  u32 context;
+  i32 retval;
+  u32 wrk_index;
+  u64 app_event_queue_address;
+  u8 n_fds;
+  u8 fd_flags;
+  u8 segment_name_length;
+  u8 segment_name[128];
+  u8 is_add;
+};
+
 /** \brief enable/disable session layer
     @param client_index - opaque cookie to identify the sender
                           client to vpp direction only