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