* 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
+ @param initial_segment_size - size of the initial shm segment to be
+ allocated
+ @param options - segment size, fifo sizes, etc.
+*/
+ define application_attach {
+ u32 client_index;
+ u32 context;
+ u32 initial_segment_size;
+ u64 options[16];
+ };
+ /** \brief Application attach reply
+ @param context - sender context, to match reply w/ request
+ @param retval - return code for the request
+ @param app_event_queue_address - vpp event queue address or 0 if this
+ connection shouldn't send events
+ @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
+*/
+define application_attach_reply {
+ u32 context;
+ i32 retval;
+ u64 app_event_queue_address;
+ u32 segment_size;
+ u8 segment_name_length;
+ u8 segment_name[128];
+};
+
+ /** \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
+*/
+autoreply define application_detach {
+ u32 client_index;
+ u32 context;
+ };
+
+/** \brief vpp->client, please map an additional shared memory segment
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param segment_name -
+*/
+autoreply define map_another_segment {
+ u32 client_index;
+ u32 context;
+ u32 segment_size;
+ u8 segment_name[128];
+};
+
/** \brief Bind to a given URI
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
"tcp://::/0/80" [ipv6] etc.
@param options - socket options, fifo sizes, etc.
*/
-define bind_uri {
+autoreply define bind_uri {
u32 client_index;
u32 context;
u32 accept_cookie;
- u32 initial_segment_size;
u8 uri[128];
- u64 options[16];
};
/** \brief Unbind a given URI
"tcp://::/0/80" [ipv6], etc.
@param options - socket options, fifo sizes, etc.
*/
-define unbind_uri {
+autoreply define unbind_uri {
u32 client_index;
u32 context;
u8 uri[128];
@param accept_cookie - sender accept cookie, to identify this bind flavor
@param uri - a URI, e.g. "tcp4://0.0.0.0/0/80"
"tcp6://::/0/80" [ipv6], etc.
- @param options - socket options, fifo sizes, etc.
+ @param options - socket options, fifo sizes, etc. passed by vpp to the
+ server when redirecting connects
+ @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];
u64 options[16];
};
-/** \brief Bind reply
- @param context - sender context, to match reply w/ request
- @param retval - return code for the request
- @param event_queue_address - vpp event queue address or 0 if this
- connection shouldn't send events
- @param segment_name_length - length of segment name
- @param segment_name - name of segment client needs to attach to
-*/
-define bind_uri_reply {
- u32 context;
- i32 retval;
- u64 server_event_queue_address;
- u8 segment_name_length;
- u32 segment_size;
- u8 segment_name[128];
-};
-
-/** \brief unbind reply
- @param context - sender context, to match reply w/ request
- @param retval - return code for the request
-*/
-define unbind_uri_reply {
- u32 context;
- i32 retval;
-};
-
-/** \brief vpp->client, connect reply
- @param context - sender context, to match reply w/ request
- @param retval - return code for the request
- @param server_rx_fifo - rx (vpp -> vpp-client) fifo address
- @param server_tx_fifo - tx (vpp-client -> vpp) fifo address
- @param session_index - session index;
- @param session_thread_index - session thread index
- @param session_type - session thread type
- @param vpp_event_queue_address - vpp's event queue address
- @param client_event_queue_address - client's event queue address
- @param segment_name_length - non-zero if the client needs to attach to
- the fifo segment
- @param segment_name - set if the client needs to attach to the segment
-*/
-define connect_uri_reply {
- u32 context;
- i32 retval;
- u64 server_rx_fifo;
- u64 server_tx_fifo;
- u32 session_index;
- u32 session_thread_index;
- u8 session_type;
- u64 client_event_queue_address;
- u64 vpp_event_queue_address;
- u32 segment_size;
- u8 segment_name_length;
- u8 segment_name[128];
-};
-
-/** \brief vpp->client, please map an additional shared memory segment
- @param context - sender context, to match reply w/ request
- @param segment_name -
-*/
-define map_another_segment {
- u32 client_index;
- u32 context;
- u32 segment_size;
- u8 segment_name[128];
-};
-
-/** \brief client->vpp
- @param context - sender context, to match reply w/ request
- @param retval - return code for the request
-*/
-define map_another_segment_reply {
- u32 context;
- i32 retval;
-};
-
/** \brief vpp->client, accept this session
@param context - sender context, to match reply w/ request
- @param accept_cookie - tells client which bind flavor just occurred
+ @param listener_handle - tells client which listener this pertains to
+ @param handle - unique session identifier
+ @param session_thread_index - thread index of new session
@param rx_fifo_address - rx (vpp -> vpp-client) fifo address
@param tx_fifo_address - tx (vpp-client -> vpp) fifo address
- @param session_index - index of new session
- @param session_thread_index - thread index of new session
@param vpp_event_queue_address - vpp's event queue address
- @param session_type - type of session
-
+ @param port - remote port
+ @param is_ip4 - 1 if the ip is ip4
+ @param ip - remote ip
*/
define accept_session {
u32 client_index;
u32 context;
- u32 accept_cookie;
+ u64 listener_handle;
+ u64 handle;
u64 server_rx_fifo;
u64 server_tx_fifo;
- u32 session_index;
- u32 session_thread_index;
u64 vpp_event_queue_address;
- u8 session_type;
+ u16 port;
+ u8 is_ip4;
+ u8 ip[16];
};
/** \brief client->vpp, reply to an accept message
define accept_session_reply {
u32 context;
i32 retval;
- u8 session_type;
- u8 session_thread_index;
- u32 session_index;
+ u64 handle;
};
/** \brief bidirectional disconnect API
@param client_index - opaque cookie to identify the sender
client to vpp direction only
@param context - sender context, to match reply w/ request
- @param session_index - cookie #1 from accept_session / connect_reply
- @param session_thread_index - cookie #2
+ @param handle - session handle obtained from accept/connect
*/
define disconnect_session {
u32 client_index;
u32 context;
- u32 session_index;
- u32 session_thread_index;
+ u64 handle;
};
/** \brief bidirectional disconnect reply API
client to vpp direction only
@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
- @param session_thread_index - thread index from accept_session /
- connect_reply
+ @param handle - session handle
*/
define disconnect_session_reply {
u32 client_index;
u32 context;
i32 retval;
- u32 session_index;
- u32 session_thread_index;
+ u64 handle;
};
/** \brief vpp->client reset session API
@param client_index - opaque cookie to identify the sender
client to vpp direction only
@param context - sender context, to match reply w/ request
- @param session_index - session index from accept_session / connect_reply
- @param session_thread_index - thread index from accept_session /
- connect_reply
+ @param handle - session handle obtained via accept/connects
*/
define reset_session {
u32 client_index;
u32 context;
- u32 session_index;
- u32 session_thread_index;
+ u64 handle;
};
/** \brief client->vpp reset session reply
client to vpp direction only
@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
- @param session_thread_index - thread index from accept_session /
- connect_reply
+ @param handle - session handle obtained via accept/connect
*/
define reset_session_reply {
u32 client_index;
u32 context;
i32 retval;
- u32 session_index;
- u32 session_thread_index;
+ u64 handle;
};
/** \brief Bind to an ip:port pair for a given transport protocol
@param context - sender context, to match reply w/ request
@param handle - bind handle obtained from bind reply
*/
-define unbind_sock {
+autoreply define unbind_sock {
u32 client_index;
u32 context;
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 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
@param proto - protocol 0 - TCP 1 - UDP
@param client_queue_address - client's API queue address. Non-zero when
used to perform redirects
- @param options - socket options, fifo sizes, etc.
+ @param options - socket options, fifo sizes, etc. when doing redirects
*/
-define connect_sock {
+autoreply define connect_sock {
u32 client_index;
u32 context;
u32 vrf;
u8 segment_name[128];
};
-/** \brief unbind reply
- @param context - sender context, to match reply w/ request
- @param retval - return code for the request
+/* Dummy connect message -- needed to satisfy api generators
+*
+* NEVER USED, doxygen tags elided on purpose.
*/
-define unbind_sock_reply {
+define connect_session {
+ u32 client_index;
u32 context;
- i32 retval;
};
-/** \brief vpp/server->client, connect reply
+/** \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
@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 client_event_queue_address - client'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
@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;
u64 server_rx_fifo;
u64 server_tx_fifo;
- u64 client_event_queue_address;
u64 vpp_event_queue_address;
u32 segment_size;
u8 segment_name_length;
u8 segment_name[128];
};
-/** \brief bidirectional disconnect API
+/** \brief enable/disable session layer
@param client_index - opaque cookie to identify the sender
client to vpp direction only
@param context - sender context, to match reply w/ request
- @param handle - session handle obtained through accept/connect
-*/
-define disconnect_sock {
- u32 client_index;
- u32 context;
- u64 handle;
-};
-
-/** \brief bidirectional disconnect reply API
- @param client_index - opaque cookie to identify the sender
- client to vpp direction only
- @param client_context - sender context, to match reply w/ request
- @param handle - session handle obtained through accept/connect
+ @param is_enable - disable session layer if 0, enable otherwise
*/
-define disconnect_sock_reply {
+autoreply define session_enable_disable {
u32 client_index;
u32 context;
- i32 retval;
- u64 handle;
+ u8 is_enable;
};
-/** \brief vpp->client, accept this session
- @param context - sender context, to match reply w/ request
- @param accept_cookie - tells client which bind flavor just occurred
- @param handle - session handle obtained through accept/connect
- @param rx_fifo_address - rx (vpp -> vpp-client) fifo address
- @param tx_fifo_address - tx (vpp-client -> vpp) fifo address
- @param vpp_event_queue_address - vpp's event queue address
-*/
-define accept_sock {
- u32 client_index;
- u32 context;
- u32 accept_cookie;
- u64 handle;
- u64 server_rx_fifo;
- u64 server_tx_fifo;
- u64 vpp_event_queue_address;
-};
-
-/** \brief client->vpp, reply to an accept message
- @param context - sender context, to match reply w/ request
- @param retval - return code for the request
- @param handle - session handle obtained through accept/connect
-*/
-define accept_sock_reply {
- u32 context;
- i32 retval;
- u64 handle;
-};
-
-/** \brief vpp->client reset session API
- @param client_index - opaque cookie to identify the sender
- client to vpp direction only
- @param context - sender context, to match reply w/ request
- @param handle - session handle obtained through accept/connect
-*/
-define reset_sock {
- u32 client_index;
- u32 context;
- u64 handle;
-};
-
-/** \brief client->vpp reset session reply
- @param client_index - opaque cookie to identify the sender
- client to vpp direction only
- @param context - sender context, to match reply w/ request
- @param handle - session handle obtained through accept/connect
-*/
-define reset_sock_reply {
- u32 client_index;
- u32 context;
- i32 retval;
- u64 handle;
-};
/*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
- */
\ No newline at end of file
+ */
Code Review / vpp.git / blobdiff