Code Coverage: vinyl-cache/include/vcli.h
 
82217aa4fc7094b3610340078afaf78cd95a8ec9
 
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2011 Varnish Software AS
3
 * All rights reserved.
4
 *
5
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6
 *
7
 * SPDX-License-Identifier: BSD-2-Clause
8
 *
9
 * Redistribution and use in source and binary forms, with or without
10
 * modification, are permitted provided that the following conditions
11
 * are met:
12
 * 1. Redistributions of source code must retain the above copyright
13
 *    notice, this list of conditions and the following disclaimer.
14
 * 2. Redistributions in binary form must reproduce the above copyright
15
 *    notice, this list of conditions and the following disclaimer in the
16
 *    documentation and/or other materials provided with the distribution.
17
 *
18
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28
 * SUCH DAMAGE.
29
 *
30
 * Public definition of the CLI protocol, part of the published Vinyl-API.
31
 *
32
 * The overall structure of the protocol is a command-line like
33
 * "command+arguments" request and a IETF style "number + string" response.
34
 *
35
 * Arguments can contain arbitrary sequences of bytes which are encoded
36
 * in back-slash notation in double-quoted, if necessary.
37
 */
38
39
/*
40
 * Status/return codes in the CLI protocol
41
 */
42
43
enum VCLI_status_e {
44
        CLIS_SYNTAX     = 100,
45
        CLIS_UNKNOWN    = 101,
46
        CLIS_UNIMPL     = 102,
47
        CLIS_TOOFEW     = 104,
48
        CLIS_TOOMANY    = 105,
49
        CLIS_PARAM      = 106,
50
        CLIS_AUTH       = 107,
51
        CLIS_OK         = 200,
52
        CLIS_TRUNCATED  = 201,
53
        CLIS_CANT       = 300,
54
        CLIS_COMMS      = 400,
55
        CLIS_CLOSE      = 500
56
};
57
58
/* Length of first line of response */
59 126408
#define CLI_LINE0_LEN   13
60
#define CLI_AUTH_RESPONSE_LEN           64      /* 64 hex + NUL */
61
62
#if !defined(VCLI_PROTOCOL_ONLY)
63
/* Convenience functions exported in libvinylapi */
64
int VCLI_WriteResult(int fd, unsigned status, const char *result);
65
int VCLI_ReadResult(int fd, unsigned *status, char **ptr, double tmo);
66
void VCLI_AuthResponse(int S_fd, const char *challenge,
67
    char response[CLI_AUTH_RESPONSE_LEN + 1]);
68
#endif