session: api to add new transport types
[vpp.git] / src / vnet / session / transport.h
index adc695f..e5c09cd 100644 (file)
 
 typedef struct _transport_options_t
 {
+  char *name;
+  char *short_name;
   transport_tx_fn_type_t tx_type;
   transport_service_type_t service_type;
   u8 half_open_has_fifos;
 } transport_options_t;
 
+typedef enum transport_snd_flags_
+{
+  TRANSPORT_SND_F_DESCHED = 1 << 0,
+  TRANSPORT_SND_F_POSTPONE = 1 << 1,
+  TRANSPORT_SND_N_FLAGS
+} __clib_packed transport_snd_flags_t;
+
+typedef struct transport_send_params_
+{
+  u32 snd_space;
+  u32 tx_offset;
+  u16 snd_mss;
+  transport_snd_flags_t flags;
+} transport_send_params_t;
+
 /*
  * Transport protocol virtual function table
  */
@@ -54,9 +71,8 @@ typedef struct _transport_proto_vft
    */
 
   u32 (*push_header) (transport_connection_t * tconn, vlib_buffer_t * b);
-  u16 (*send_mss) (transport_connection_t * tc);
-  u32 (*send_space) (transport_connection_t * tc);
-  u32 (*tx_fifo_offset) (transport_connection_t * tc);
+  int (*send_params) (transport_connection_t * tconn,
+                     transport_send_params_t *sp);
   void (*update_time) (f64 time_now, u8 thread_index);
   void (*flush_data) (transport_connection_t *tconn);
   int (*custom_tx) (void *session, u32 max_burst_size);
@@ -151,19 +167,51 @@ transport_app_rx_evt (transport_proto_t tp, u32 conn_index, u32 thread_index)
 }
 
 /**
- * Get maximum tx burst allowed for transport connection
+ * Get send parameters for transport connection
+ *
+ * These include maximum tx burst, mss, tx offset and other flags
+ * transport might want to provide to sessin layer
  *
  * @param tc           transport connection
+ * @param sp           send paramaters
+ *
  */
 static inline u32
-transport_connection_snd_space (transport_connection_t * tc)
+transport_connection_snd_params (transport_connection_t * tc,
+                                transport_send_params_t * sp)
+{
+  return tp_vfts[tc->proto].send_params (tc, sp);
+}
+
+static inline u8
+transport_connection_is_descheduled (transport_connection_t * tc)
+{
+  return ((tc->flags & TRANSPORT_CONNECTION_F_DESCHED) ? 1 : 0);
+}
+
+static inline void
+transport_connection_deschedule (transport_connection_t * tc)
 {
-  return tp_vfts[tc->proto].send_space (tc);
+  tc->flags |= TRANSPORT_CONNECTION_F_DESCHED;
 }
 
+void transport_connection_reschedule (transport_connection_t * tc);
+
+/**
+ * Register transport virtual function table.
+ *
+ * @param transport_proto - transport protocol type (i.e., TCP, UDP ..)
+ * @param vft - virtual function table for transport proto
+ * @param fib_proto - network layer protocol
+ * @param output_node - output node index that session layer will hand off
+ *                     buffers to, for requested fib proto
+ */
 void transport_register_protocol (transport_proto_t transport_proto,
                                  const transport_proto_vft_t * vft,
                                  fib_protocol_t fib_proto, u32 output_node);
+transport_proto_t
+transport_register_new_protocol (const transport_proto_vft_t * vft,
+                                fib_protocol_t fib_proto, u32 output_node);
 transport_proto_vft_t *transport_protocol_get_vft (transport_proto_t tp);
 void transport_update_time (clib_time_type_t time_now, u8 thread_index);