bapi: add options to have vpp cleanup client registration
[vpp.git] / src / vlibmemory / memory_client.h
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_MEMORY_CLIENT_H_
19 #define SRC_VLIBMEMORY_MEMORY_CLIENT_H_
20
21 #include <vlibmemory/memory_shared.h>
22
23 int vl_client_connect (const char *name, int ctx_quota, int input_queue_size);
24 void vl_client_send_disconnect (u8 do_cleanup);
25 int vl_client_disconnect (void);
26 int vl_client_api_map (const char *region_name);
27 void vl_client_api_unmap (void);
28 void vl_client_disconnect_from_vlib (void);
29 void vl_client_disconnect_from_vlib_no_unmap (void);
30 int vl_client_connect_to_vlib (const char *svm_name, const char *client_name,
31                                int rx_queue_size);
32 int vl_client_connect_to_vlib_no_rx_pthread (const char *svm_name,
33                                              const char *client_name,
34                                              int rx_queue_size);
35 int vl_client_connect_to_vlib_no_map (const char *svm_name,
36                                       const char *client_name,
37                                       int rx_queue_size);
38 void vl_client_install_client_message_handlers (void);
39 u8 vl_mem_client_is_connected (void);
40
41 #endif /* SRC_VLIBMEMORY_MEMORY_CLIENT_H_ */
42
43 /*
44  * fd.io coding-style-patch-verification: ON
45  *
46  * Local Variables:
47  * eval: (c-set-style "gnu")
48  * End:
49  */