1 06a99fe3SHajimu UMEMOTO /*- 2 *4d846d26SWarner Losh * SPDX-License-Identifier: BSD-2-Clause 3 d915a14eSPedro F. Giffuni * 4 06a99fe3SHajimu UMEMOTO * Copyright (c) 2004 Michael Bushkov <bushman@rsu.ru> 5 06a99fe3SHajimu UMEMOTO * All rights reserved. 6 06a99fe3SHajimu UMEMOTO * 7 06a99fe3SHajimu UMEMOTO * Redistribution and use in source and binary forms, with or without 8 06a99fe3SHajimu UMEMOTO * modification, are permitted provided that the following conditions 9 06a99fe3SHajimu UMEMOTO * are met: 10 06a99fe3SHajimu UMEMOTO * 1. Redistributions of source code must retain the above copyright 11 06a99fe3SHajimu UMEMOTO * notice, this list of conditions and the following disclaimer. 12 06a99fe3SHajimu UMEMOTO * 2. Redistributions in binary form must reproduce the above copyright 13 06a99fe3SHajimu UMEMOTO * notice, this list of conditions and the following disclaimer in the 14 06a99fe3SHajimu UMEMOTO * documentation and/or other materials provided with the distribution. 15 06a99fe3SHajimu UMEMOTO * 16 06a99fe3SHajimu UMEMOTO * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 06a99fe3SHajimu UMEMOTO * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 06a99fe3SHajimu UMEMOTO * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 06a99fe3SHajimu UMEMOTO * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 06a99fe3SHajimu UMEMOTO * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 06a99fe3SHajimu UMEMOTO * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 06a99fe3SHajimu UMEMOTO * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 06a99fe3SHajimu UMEMOTO * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 06a99fe3SHajimu UMEMOTO * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 06a99fe3SHajimu UMEMOTO * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 06a99fe3SHajimu UMEMOTO * SUCH DAMAGE. 27 06a99fe3SHajimu UMEMOTO */ 28 06a99fe3SHajimu UMEMOTO 29 06a99fe3SHajimu UMEMOTO #ifndef __NS_CACHED_CLI_H__ 30 06a99fe3SHajimu UMEMOTO #define __NS_CACHED_CLI_H__ 31 06a99fe3SHajimu UMEMOTO 32 06a99fe3SHajimu UMEMOTO /* 33 06a99fe3SHajimu UMEMOTO * This file contains API for working with caching daemon 34 06a99fe3SHajimu UMEMOTO */ 35 06a99fe3SHajimu UMEMOTO 36 06a99fe3SHajimu UMEMOTO enum comm_element_t { 37 06a99fe3SHajimu UMEMOTO CET_UNDEFINED = 0, 38 06a99fe3SHajimu UMEMOTO CET_WRITE_REQUEST = 1, 39 06a99fe3SHajimu UMEMOTO CET_WRITE_RESPONSE = 2, 40 06a99fe3SHajimu UMEMOTO CET_READ_REQUEST = 3, 41 06a99fe3SHajimu UMEMOTO CET_READ_RESPONSE = 4, 42 06a99fe3SHajimu UMEMOTO CET_TRANSFORM_REQUEST = 5, 43 06a99fe3SHajimu UMEMOTO CET_TRANSFORM_RESPONSE = 6, 44 06a99fe3SHajimu UMEMOTO CET_MP_WRITE_SESSION_REQUEST = 7, 45 06a99fe3SHajimu UMEMOTO CET_MP_WRITE_SESSION_RESPONSE = 8, 46 06a99fe3SHajimu UMEMOTO CET_MP_WRITE_SESSION_WRITE_REQUEST = 9, 47 06a99fe3SHajimu UMEMOTO CET_MP_WRITE_SESSION_WRITE_RESPONSE = 10, 48 06a99fe3SHajimu UMEMOTO CET_MP_WRITE_SESSION_CLOSE_NOTIFICATION = 11, 49 06a99fe3SHajimu UMEMOTO CET_MP_WRITE_SESSION_ABANDON_NOTIFICATION = 12, 50 06a99fe3SHajimu UMEMOTO CET_MP_READ_SESSION_REQUEST = 13, 51 06a99fe3SHajimu UMEMOTO CET_MP_READ_SESSION_RESPONSE = 14, 52 06a99fe3SHajimu UMEMOTO CET_MP_READ_SESSION_READ_REQUEST = 15, 53 06a99fe3SHajimu UMEMOTO CET_MP_READ_SESSION_READ_RESPONSE = 16, 54 06a99fe3SHajimu UMEMOTO CET_MP_READ_SESSION_CLOSE_NOTIFICATION = 17 55 06a99fe3SHajimu UMEMOTO }; 56 06a99fe3SHajimu UMEMOTO 57 06a99fe3SHajimu UMEMOTO struct cached_connection_params { 58 06a99fe3SHajimu UMEMOTO char *socket_path; 59 06a99fe3SHajimu UMEMOTO struct timeval timeout; 60 06a99fe3SHajimu UMEMOTO }; 61 06a99fe3SHajimu UMEMOTO 62 06a99fe3SHajimu UMEMOTO struct cached_connection_ { 63 06a99fe3SHajimu UMEMOTO int sockfd; 64 06a99fe3SHajimu UMEMOTO int read_queue; 65 06a99fe3SHajimu UMEMOTO int write_queue; 66 06a99fe3SHajimu UMEMOTO 67 06a99fe3SHajimu UMEMOTO int mp_flag; /* shows if the connection is used for 68 06a99fe3SHajimu UMEMOTO * multipart operations */ 69 06a99fe3SHajimu UMEMOTO }; 70 06a99fe3SHajimu UMEMOTO 71 06a99fe3SHajimu UMEMOTO /* simple abstractions for not to write "struct" every time */ 72 06a99fe3SHajimu UMEMOTO typedef struct cached_connection_ *cached_connection; 73 06a99fe3SHajimu UMEMOTO typedef struct cached_connection_ *cached_mp_write_session; 74 06a99fe3SHajimu UMEMOTO typedef struct cached_connection_ *cached_mp_read_session; 75 06a99fe3SHajimu UMEMOTO 76 06a99fe3SHajimu UMEMOTO #define INVALID_CACHED_CONNECTION (NULL) 77 06a99fe3SHajimu UMEMOTO #define INVALID_CACHED_MP_WRITE_SESSION (NULL) 78 06a99fe3SHajimu UMEMOTO #define INVALID_CACHED_MP_READ_SESSION (NULL) 79 06a99fe3SHajimu UMEMOTO 80 06a99fe3SHajimu UMEMOTO __BEGIN_DECLS 81 06a99fe3SHajimu UMEMOTO 82 06a99fe3SHajimu UMEMOTO /* initialization/destruction routines */ 83 06a99fe3SHajimu UMEMOTO extern cached_connection __open_cached_connection( 84 06a99fe3SHajimu UMEMOTO struct cached_connection_params const *); 85 06a99fe3SHajimu UMEMOTO extern void __close_cached_connection(cached_connection); 86 06a99fe3SHajimu UMEMOTO 87 06a99fe3SHajimu UMEMOTO /* simple read/write operations */ 88 06a99fe3SHajimu UMEMOTO extern int __cached_write(cached_connection, const char *, const char *, 89 06a99fe3SHajimu UMEMOTO size_t, const char *, size_t); 90 06a99fe3SHajimu UMEMOTO extern int __cached_read(cached_connection, const char *, const char *, 91 06a99fe3SHajimu UMEMOTO size_t, char *, size_t *); 92 06a99fe3SHajimu UMEMOTO 93 06a99fe3SHajimu UMEMOTO /* multipart read/write operations */ 94 06a99fe3SHajimu UMEMOTO extern cached_mp_write_session __open_cached_mp_write_session( 95 06a99fe3SHajimu UMEMOTO struct cached_connection_params const *, const char *); 96 06a99fe3SHajimu UMEMOTO extern int __cached_mp_write(cached_mp_write_session, const char *, size_t); 97 06a99fe3SHajimu UMEMOTO extern int __abandon_cached_mp_write_session(cached_mp_write_session); 98 06a99fe3SHajimu UMEMOTO extern int __close_cached_mp_write_session(cached_mp_write_session); 99 06a99fe3SHajimu UMEMOTO 100 06a99fe3SHajimu UMEMOTO extern cached_mp_read_session __open_cached_mp_read_session( 101 06a99fe3SHajimu UMEMOTO struct cached_connection_params const *, const char *); 102 06a99fe3SHajimu UMEMOTO extern int __cached_mp_read(cached_mp_read_session, char *, size_t *); 103 06a99fe3SHajimu UMEMOTO extern int __close_cached_mp_read_session(cached_mp_read_session); 104 06a99fe3SHajimu UMEMOTO 105 06a99fe3SHajimu UMEMOTO __END_DECLS 106 06a99fe3SHajimu UMEMOTO 107 06a99fe3SHajimu UMEMOTO #endif 108