src/vnet/session/application_interface.h

   1 /*
   2  * Copyright (c) 2016 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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15 #ifndef __included_uri_h__
  16 #define __included_uri_h__
  17
  18 #include <vlib/vlib.h>
  19 #include <vnet/vnet.h>
  20 #include <svm/svm_fifo_segment.h>
  21 #include <vnet/session/session.h>
  22 #include <vnet/session/application.h>
  23 #include <vnet/session/transport.h>
  24
  25 typedef enum _session_api_proto
  26 {
  27   SESSION_PROTO_TCP,
  28   SESSION_PROTO_UDP
  29 } session_api_proto_t;
  30
  31 typedef struct _vnet_bind_args_t
  32 {
  33   union
  34   {
  35     char *uri;
  36     struct
  37     {
  38       transport_endpoint_t tep;
  39       session_api_proto_t proto;
  40     };
  41   };
  42
  43   u32 api_client_index;
  44   u64 *options;
  45   session_cb_vft_t *session_cb_vft;
  46
  47   /*
  48    * Results
  49    */
  50   char *segment_name;
  51   u32 segment_name_length;
  52   u64 server_event_queue_address;
  53   u64 handle;
  54 } vnet_bind_args_t;
  55
  56 typedef struct _vnet_unbind_args_t
  57 {
  58   union
  59   {
  60     char *uri;
  61     u64 handle;
  62   };
  63   u32 api_client_index;
  64 } vnet_unbind_args_t;
  65
  66 typedef struct _vnet_connect_args
  67 {
  68   union
  69   {
  70     char *uri;
  71     struct
  72     {
  73       transport_endpoint_t tep;
  74       session_api_proto_t proto;
  75     };
  76   };
  77   u32 api_client_index;
  78   u32 api_context;
  79   u64 *options;
  80   session_cb_vft_t *session_cb_vft;
  81
  82   /* Used for redirects */
  83   void *mp;
  84 } vnet_connect_args_t;
  85
  86 typedef struct _vnet_disconnect_args_t
  87 {
  88   u64 handle;
  89   u32 api_client_index;
  90 } vnet_disconnect_args_t;
  91
  92 /* Bind / connect options */
  93 typedef enum
  94 {
  95   SESSION_OPTIONS_FLAGS,
  96   SESSION_OPTIONS_SEGMENT_SIZE,
  97   SESSION_OPTIONS_ADD_SEGMENT_SIZE,
  98   SESSION_OPTIONS_RX_FIFO_SIZE,
  99   SESSION_OPTIONS_TX_FIFO_SIZE,
 100   SESSION_OPTIONS_ACCEPT_COOKIE,
 101   SESSION_OPTIONS_N_OPTIONS
 102 } session_options_index_t;
 103
 104 /** Server can handle delegated connect requests from local clients */
 105 #define SESSION_OPTIONS_FLAGS_USE_FIFO  (1<<0)
 106
 107 /** Server wants vpp to add segments when out of memory for fifos */
 108 #define SESSION_OPTIONS_FLAGS_ADD_SEGMENT   (1<<1)
 109
 110 #define VNET_CONNECT_REDIRECTED 123
 111
 112 int vnet_bind_uri (vnet_bind_args_t *);
 113 int vnet_unbind_uri (char *uri, u32 api_client_index);
 114 int vnet_connect_uri (vnet_connect_args_t * a);
 115 int
 116 vnet_disconnect_session (u32 client_index, u32 session_index,
 117                          u32 thread_index);
 118
 119 int vnet_bind (vnet_bind_args_t * a);
 120 int vnet_connect (vnet_connect_args_t * a);
 121 int vnet_unbind (vnet_unbind_args_t * a);
 122 int vnet_disconnect (vnet_disconnect_args_t * a);
 123
 124 int
 125 api_parse_session_handle (u64 handle, u32 * session_index,
 126                           u32 * thread_index);
 127
 128 #endif /* __included_uri_h__ */
 129
 130 /*
 131  * fd.io coding-style-patch-verification: ON
 132  *
 133  * Local Variables:
 134  * eval: (c-set-style "gnu")
 135  * End:
 136  */