FD.io VPP  v18.07.1-19-g511ce25
Vector Packet Processing
api.h
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * api.h
4  *
5  * Copyright (c) 2009 Cisco and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *------------------------------------------------------------------
18  */
19 
20 #ifndef included_vlibsocket_api_h
21 #define included_vlibsocket_api_h
22 
23 #include <vlibapi/api.h>
24 
25 typedef struct
26 {
27  /* Server port number */
28  int portno;
29 
30  /* By default, localhost... */
31  u32 bind_address;
32 
33  /*
34  * (listen, server, client) registrations. Shared memory
35  * registrations are in shared memory
36  */
37  vl_api_registration_t *registration_pool;
38  /*
39  * Chain-drag variables, so message API handlers
40  * (generally) don't know whether they're talking to a socket
41  * or to a shared-memory connection.
42  */
43  vl_api_registration_t *current_rp;
44  clib_file_t *current_uf;
45  /* One input buffer, shared across all sockets */
46  i8 *input_buffer;
48 
50 
52  struct vl_api_registration_ *cf,
53  u8 * buffer, uword buffer_bytes);
54 
55 #define SOCKSVR_DEFAULT_PORT 32741 /* whatever */
56 
57 void vl_free_socket_registration_index (u32 pool_index);
59  struct vl_api_registration_ *rp, i8 * input_v);
62  struct vl_api_registration_ *rp,
63  u8 * buffer, uword buffer_bytes);
65 void vl_socket_api_send (vl_api_registration_t * rp, u8 * elem);
67  u8 * elem, u8 * data_vector);
69  u8 * elem, u32 msg_length);
71  u8 * elem, u32 msg_length);
72 u32 sockclnt_open_index (char *client_name, char *hostname, int port);
73 void sockclnt_close_index (u32 index);
76 void socksvr_set_port (u16 port);
77 void socksvr_set_bind_address (u32 bind_address);
78 
79 #endif /* included_vlibsocket_api_h */
80 
81 /*
82  * fd.io coding-style-patch-verification: ON
83  *
84  * Local Variables:
85  * eval: (c-set-style "gnu")
86  * End:
87  */
void vl_socket_api_send(vl_api_registration_t *rp, u8 *elem)
Definition: socket_api.c:78
void socksvr_set_port(u16 port)
unsigned char u8
Definition: types.h:56
socket_main_t socket_main
Definition: socket_api.c:48
void sockclnt_close_index(u32 index)
void vl_client_msg_api_send(vl_api_registration_t *cm, u8 *elem)
void vl_socket_add_pending_output(clib_file_t *uf, struct vl_api_registration_ *rp, u8 *buffer, uword buffer_bytes)
Definition: socket_api.c:270
void vl_socket_api_send_with_length(vl_api_registration_t *rp, u8 *elem, u32 msg_length)
clib_error_t * vl_socket_read_ready(clib_file_t *uf)
Definition: socket_api.c:158
void vl_socket_api_send_with_data(vl_api_registration_t *rp, u8 *elem, u8 *data_vector)
vl_api_registration_t * sockclnt_get_registration(u32 index)
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
signed char i8
Definition: types.h:45
clib_error_t * vl_socket_write_ready(clib_file_t *uf)
Definition: socket_api.c:311
u32 sockclnt_open_index(char *client_name, char *hostname, int port)
Definition: sockclnt_vlib.c:72
An API client registration, only in vpp/vlib.
Definition: api_common.h:44
int portno
Definition: api.h:28
void vl_free_socket_registration_index(u32 pool_index)
u64 uword
Definition: types.h:112
Definition: file.h:51
void socksvr_set_bind_address(u32 bind_address)
void vl_socket_process_msg(struct clib_file *uf, struct vl_api_registration_ *rp, i8 *input_v)
void vl_socket_api_send_with_length_no_free(vl_api_registration_t *rp, u8 *elem, u32 msg_length)
void socksvr_add_pending_output(struct clib_file *uf, struct vl_api_registration_ *cf, u8 *buffer, uword buffer_bytes)