FD.io VPP
v18.10-34-gcce845e
Vector Packet Processing
Main Page
Related Pages
Modules
Namespaces
Data Structures
Source
Files
Symbols
socket_client.h
Go to the documentation of this file.
1
/*
2
*------------------------------------------------------------------
3
* Copyright (c) 2018 Cisco and/or its affiliates.
4
* Licensed under the Apache License, Version 2.0 (the "License");
5
* you may not use this file except in compliance with the License.
6
* You may obtain a copy of the License at:
7
*
8
* http://www.apache.org/licenses/LICENSE-2.0
9
*
10
* Unless required by applicable law or agreed to in writing, software
11
* distributed under the License is distributed on an "AS IS" BASIS,
12
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
* See the License for the specific language governing permissions and
14
* limitations under the License.
15
*------------------------------------------------------------------
16
*/
17
18
#ifndef SRC_VLIBMEMORY_SOCKET_CLIENT_H_
19
#define SRC_VLIBMEMORY_SOCKET_CLIENT_H_
20
21
#include <
vppinfra/file.h
>
22
#include <
vppinfra/time.h
>
23
#include <
vlibmemory/memory_shared.h
>
24
25
typedef
struct
26
{
27
int
socket_fd
;
28
int
socket_enable
;
/**< Can temporarily disable the connection
29
but still can keep it around... */
30
u32
client_index
;
/**< Client index allocated by VPP */
31
32
clib_socket_t
client_socket
;
33
34
u32
socket_buffer_size
;
35
u8
*
socket_tx_buffer
;
36
u8
*
socket_rx_buffer
;
37
u32
socket_tx_nbytes
;
38
int
control_pings_outstanding
;
39
40
u8
*
name
;
41
clib_time_t
clib_time
;
42
ssvm_private_t
memfd_segment
;
43
}
socket_client_main_t
;
44
45
extern
socket_client_main_t
socket_client_main
;
46
47
#define SOCKET_CLIENT_DEFAULT_BUFFER_SIZE 4096
48
49
int
vl_socket_client_connect
(
char
*socket_path,
char
*client_name,
50
u32
socket_buffer_size);
51
void
vl_socket_client_disconnect
(
void
);
52
int
vl_socket_client_read
(
int
wait);
53
int
vl_socket_client_write
(
void
);
54
void
vl_socket_client_enable_disable
(
int
enable);
55
void
*
vl_socket_client_msg_alloc
(
int
nbytes);
56
int
vl_socket_client_init_shm
(
vl_api_shm_elem_config_t
* config);
57
clib_error_t
*
vl_socket_client_recv_fd_msg
(
int
fds[],
int
n_fds,
u32
wait);
58
59
#endif
/* SRC_VLIBMEMORY_SOCKET_CLIENT_H_ */
60
61
/*
62
* fd.io coding-style-patch-verification: ON
63
*
64
* Local Variables:
65
* eval: (c-set-style "gnu")
66
* End:
67
*/
socket_client_main_t::socket_rx_buffer
u8 * socket_rx_buffer
Definition:
socket_client.h:36
socket_client_main_t::name
u8 * name
Definition:
socket_client.h:40
socket_client_main_t::memfd_segment
ssvm_private_t memfd_segment
Definition:
socket_client.h:42
time.h
vl_api_shm_elem_config_
Definition:
memory_shared.h:51
socket_client_main_t::socket_fd
int socket_fd
Definition:
socket_client.h:27
socket_client_main_t::control_pings_outstanding
int control_pings_outstanding
Definition:
socket_client.h:38
vl_socket_client_init_shm
int vl_socket_client_init_shm(vl_api_shm_elem_config_t *config)
Definition:
socket_client.c:398
u8
unsigned char u8
Definition:
types.h:56
file.h
socket_client_main_t::clib_time
clib_time_t clib_time
Definition:
socket_client.h:41
socket_client_main
socket_client_main_t socket_client_main
Definition:
socket_client.c:44
u32
unsigned int u32
Definition:
types.h:88
vl_socket_client_write
int vl_socket_client_write(void)
Definition:
socket_client.c:136
vl_socket_client_msg_alloc
void * vl_socket_client_msg_alloc(int nbytes)
Definition:
socket_client.c:165
vl_socket_client_read
int vl_socket_client_read(int wait)
Definition:
socket_client.c:56
socket_client_main_t::socket_tx_buffer
u8 * socket_tx_buffer
Definition:
socket_client.h:35
socket_client_main_t::client_socket
clib_socket_t client_socket
Definition:
socket_client.h:32
vl_socket_client_enable_disable
void vl_socket_client_enable_disable(int enable)
Definition:
socket_client.c:187
memory_shared.h
socket_client_main_t::socket_tx_nbytes
u32 socket_tx_nbytes
Definition:
socket_client.h:37
socket_client_main_t
Definition:
socket_client.h:25
clib_time_t
Definition:
time.h:43
clib_socket_t
struct _socket_t clib_socket_t
socket_client_main_t::socket_buffer_size
u32 socket_buffer_size
Definition:
socket_client.h:34
clib_error_t
Definition:
clib_error.h:21
socket_client_main_t::client_index
u32 client_index
Client index allocated by VPP.
Definition:
socket_client.h:30
socket_client_main_t::socket_enable
int socket_enable
Can temporarily disable the connection but still can keep it around...
Definition:
socket_client.h:28
ssvm_private_t
Definition:
ssvm.h:81
vl_socket_client_connect
int vl_socket_client_connect(char *socket_path, char *client_name, u32 socket_buffer_size)
Definition:
socket_client.c:343
vl_socket_client_recv_fd_msg
clib_error_t * vl_socket_client_recv_fd_msg(int fds[], int n_fds, u32 wait)
Definition:
socket_client.c:432
vl_socket_client_disconnect
void vl_socket_client_disconnect(void)
Definition:
socket_client.c:172
src
vlibmemory
socket_client.h
Generated on Thu May 16 2019 14:25:56 for FD.io VPP by
1.8.11