1158115Sume/*- 2158115Sume * Copyright (c) 2004 Michael Bushkov <bushman@rsu.ru> 3158115Sume * All rights reserved. 4158115Sume * 5158115Sume * Redistribution and use in source and binary forms, with or without 6158115Sume * modification, are permitted provided that the following conditions 7158115Sume * are met: 8158115Sume * 1. Redistributions of source code must retain the above copyright 9158115Sume * notice, this list of conditions and the following disclaimer. 10158115Sume * 2. Redistributions in binary form must reproduce the above copyright 11158115Sume * notice, this list of conditions and the following disclaimer in the 12158115Sume * documentation and/or other materials provided with the distribution. 13158115Sume * 14158115Sume * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15158115Sume * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16158115Sume * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17158115Sume * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18158115Sume * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19158115Sume * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20158115Sume * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21158115Sume * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22158115Sume * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23158115Sume * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24158115Sume * SUCH DAMAGE. 25158115Sume * 26158115Sume * $FreeBSD: releng/10.3/lib/libc/include/nscachedcli.h 158115 2006-04-28 12:03:38Z ume $ 27158115Sume */ 28158115Sume 29158115Sume#ifndef __NS_CACHED_CLI_H__ 30158115Sume#define __NS_CACHED_CLI_H__ 31158115Sume 32158115Sume/* 33158115Sume * This file contains API for working with caching daemon 34158115Sume */ 35158115Sume 36158115Sumeenum comm_element_t { 37158115Sume CET_UNDEFINED = 0, 38158115Sume CET_WRITE_REQUEST = 1, 39158115Sume CET_WRITE_RESPONSE = 2, 40158115Sume CET_READ_REQUEST = 3, 41158115Sume CET_READ_RESPONSE = 4, 42158115Sume CET_TRANSFORM_REQUEST = 5, 43158115Sume CET_TRANSFORM_RESPONSE = 6, 44158115Sume CET_MP_WRITE_SESSION_REQUEST = 7, 45158115Sume CET_MP_WRITE_SESSION_RESPONSE = 8, 46158115Sume CET_MP_WRITE_SESSION_WRITE_REQUEST = 9, 47158115Sume CET_MP_WRITE_SESSION_WRITE_RESPONSE = 10, 48158115Sume CET_MP_WRITE_SESSION_CLOSE_NOTIFICATION = 11, 49158115Sume CET_MP_WRITE_SESSION_ABANDON_NOTIFICATION = 12, 50158115Sume CET_MP_READ_SESSION_REQUEST = 13, 51158115Sume CET_MP_READ_SESSION_RESPONSE = 14, 52158115Sume CET_MP_READ_SESSION_READ_REQUEST = 15, 53158115Sume CET_MP_READ_SESSION_READ_RESPONSE = 16, 54158115Sume CET_MP_READ_SESSION_CLOSE_NOTIFICATION = 17 55158115Sume}; 56158115Sume 57158115Sumestruct cached_connection_params { 58158115Sume char *socket_path; 59158115Sume struct timeval timeout; 60158115Sume}; 61158115Sume 62158115Sumestruct cached_connection_ { 63158115Sume int sockfd; 64158115Sume int read_queue; 65158115Sume int write_queue; 66158115Sume 67158115Sume int mp_flag; /* shows if the connection is used for 68158115Sume * multipart operations */ 69158115Sume}; 70158115Sume 71158115Sume/* simple abstractions for not to write "struct" every time */ 72158115Sumetypedef struct cached_connection_ *cached_connection; 73158115Sumetypedef struct cached_connection_ *cached_mp_write_session; 74158115Sumetypedef struct cached_connection_ *cached_mp_read_session; 75158115Sume 76158115Sume#define INVALID_CACHED_CONNECTION (NULL) 77158115Sume#define INVALID_CACHED_MP_WRITE_SESSION (NULL) 78158115Sume#define INVALID_CACHED_MP_READ_SESSION (NULL) 79158115Sume 80158115Sume__BEGIN_DECLS 81158115Sume 82158115Sume/* initialization/destruction routines */ 83158115Sumeextern cached_connection __open_cached_connection( 84158115Sume struct cached_connection_params const *); 85158115Sumeextern void __close_cached_connection(cached_connection); 86158115Sume 87158115Sume/* simple read/write operations */ 88158115Sumeextern int __cached_write(cached_connection, const char *, const char *, 89158115Sume size_t, const char *, size_t); 90158115Sumeextern int __cached_read(cached_connection, const char *, const char *, 91158115Sume size_t, char *, size_t *); 92158115Sume 93158115Sume/* multipart read/write operations */ 94158115Sumeextern cached_mp_write_session __open_cached_mp_write_session( 95158115Sume struct cached_connection_params const *, const char *); 96158115Sumeextern int __cached_mp_write(cached_mp_write_session, const char *, size_t); 97158115Sumeextern int __abandon_cached_mp_write_session(cached_mp_write_session); 98158115Sumeextern int __close_cached_mp_write_session(cached_mp_write_session); 99158115Sume 100158115Sumeextern cached_mp_read_session __open_cached_mp_read_session( 101158115Sume struct cached_connection_params const *, const char *); 102158115Sumeextern int __cached_mp_read(cached_mp_read_session, char *, size_t *); 103158115Sumeextern int __close_cached_mp_read_session(cached_mp_read_session); 104158115Sume 105158115Sume__END_DECLS 106158115Sume 107158115Sume#endif 108