vppapigen: support per-file (major,minor,patch) version stamps
[vpp.git] / src / vnet / session / session.api
index 4aef09d..992a063 100644 (file)
@@ -12,7 +12,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+vl_api_version 1.0.0
+
 /** \brief client->vpp, attach application to session layer
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -105,7 +107,7 @@ autoreply define unbind_uri {
     @param client_queue_address - binary API client queue address. Used by 
                                                          local server when connect was redirected.
 */
-define connect_uri {
+autoreply define connect_uri {
   u32 client_index;
   u32 context;
   u8 uri[128];
@@ -113,31 +115,6 @@ define connect_uri {
   u64 options[16];
 };
 
-/** \brief vpp->client, connect reply
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the request
-    @param handle - session handle
-    @param server_rx_fifo - rx (vpp -> vpp-client) fifo address 
-    @param server_tx_fifo - tx (vpp-client -> vpp) fifo address 
-    @param vpp_event_queue_address - vpp's event queue address
-    @param segment_size - size of segment to be attached. Only for redirects.
-    @param segment_name_length - non-zero if the client needs to attach to 
-                                 the fifo segment. This should only happen 
-                                 if session was redirected.
-    @param segment_name - set if the client needs to attach to the segment
-*/
-define connect_uri_reply {
-  u32 context;
-  i32 retval;
-  u64 handle;
-  u64 server_rx_fifo;
-  u64 server_tx_fifo;
-  u64 vpp_event_queue_address;
-  u32 segment_size;
-  u8 segment_name_length;
-  u8 segment_name[128];
-};
-
 /** \brief vpp->client, accept this session
     @param context - sender context, to match reply w/ request
     @param listener_handle - tells client which listener this pertains to
@@ -263,6 +240,7 @@ autoreply define unbind_sock {
 /** \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 app_connect - application connection id to be returned in reply
     @param vrf - connection namespace
     @param is_ip4 - flag that is 1 if ip address family is IPv4
     @param ip - ip address
@@ -272,7 +250,7 @@ autoreply define unbind_sock {
                                   used to perform redirects
     @param options - socket options, fifo sizes, etc. when doing redirects
 */
-define connect_sock {
+autoreply define connect_sock {
   u32 client_index;
   u32 context;
   u32 vrf;
@@ -303,7 +281,16 @@ define bind_sock_reply {
   u8 segment_name[128];
 };
 
-/** \brief vpp/server->client, connect reply
+/* Dummy connect message -- needed to satisfy api generators
+*
+*  NEVER USED, doxygen tags elided on purpose.
+*/
+define connect_session {
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief vpp/server->client, connect reply -- used for all connect_* messages
     @param context - sender context, to match reply w/ request
     @param retval - return code for the request
     @param handle - connection handle
@@ -315,7 +302,7 @@ define bind_sock_reply {
                                  the fifo segment
     @param segment_name - set if the client needs to attach to the segment
 */
-define connect_sock_reply {
+define connect_session_reply {
   u32 context;
   i32 retval;
   u64 handle;