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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
18 #ifndef SRC_VLIBMEMORY_SOCKET_CLIENT_H_
19 #define SRC_VLIBMEMORY_SOCKET_CLIENT_H_
21 #include <vppinfra/file.h>
22 #include <vppinfra/time.h>
23 #include <vlibapi/memory_shared.h>
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 */
32 clib_socket_t client_socket;
34 u32 socket_buffer_size;
37 int control_pings_outstanding;
40 clib_time_t clib_time;
41 ssvm_private_t memfd_segment;
44 } socket_client_main_t;
46 extern socket_client_main_t socket_client_main;
48 #define SOCKET_CLIENT_DEFAULT_BUFFER_SIZE 4096
50 int vl_socket_client_connect (char *socket_path, char *client_name,
51 u32 socket_buffer_size);
52 void vl_socket_client_disconnect (void);
53 void vl_socket_client_enable_disable (int enable);
54 int vl_socket_client_read (int wait);
55 int vl_socket_client_write (void);
56 void *vl_socket_client_msg_alloc (int nbytes);
57 int vl_socket_client_init_shm (vl_api_shm_elem_config_t * config,
59 clib_error_t *vl_socket_client_recv_fd_msg (int fds[], int n_fds, u32 wait);
62 * Socket client apis that explicitly pass socket main as an argument
65 int vl_socket_client_connect2 (socket_client_main_t * scm, char *socket_path,
66 char *client_name, u32 socket_buffer_size);
67 void vl_socket_client_disconnect2 (socket_client_main_t * scm);
68 void vl_socket_client_enable_disable2 (socket_client_main_t * scm,
70 int vl_socket_client_read2 (socket_client_main_t * scm, int wait);
71 int vl_socket_client_write2 (socket_client_main_t * scm);
72 void *vl_socket_client_msg_alloc2 (socket_client_main_t * scm, int nbytes);
73 int vl_socket_client_init_shm2 (socket_client_main_t * scm,
74 vl_api_shm_elem_config_t * config,
76 clib_error_t *vl_socket_client_recv_fd_msg2 (socket_client_main_t * scm,
77 int fds[], int n_fds, u32 wait);
79 #endif /* SRC_VLIBMEMORY_SOCKET_CLIENT_H_ */
82 * fd.io coding-style-patch-verification: ON
85 * eval: (c-set-style "gnu")