client.h 3.39 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
/* Icecast
 *
 * This program is distributed under the GNU General Public License, version 2.
 * A copy of this license is included with this source.
 *
 * Copyright 2000-2004, Jack Moffitt <jack@xiph.org, 
 *                      Michael Smith <msmith@xiph.org>,
 *                      oddsock <oddsock@xiph.org>,
 *                      Karl Heyes <karl@xiph.org>
 *                      and others (see AUTHORS for details).
11
 * Copyright 2011-2018, Philipp "ph3-der-loewe" Schafft <lion@lion.leolix.org>,
12
13
 */

Jack Moffitt's avatar
Jack Moffitt committed
14
/* client.h
15
16
17
18
 **
 ** client data structions and function definitions
 **
 */
Jack Moffitt's avatar
Jack Moffitt committed
19
20
21
#ifndef __CLIENT_H__
#define __CLIENT_H__

22
23
typedef struct _client_tag client_t;

24
#include "errors.h"
Michael Smith's avatar
Michael Smith committed
25
#include "connection.h"
Michael Smith's avatar
Michael Smith committed
26
#include "refbuf.h"
Philipp Schafft's avatar
Philipp Schafft committed
27
#include "acl.h"
28
#include "cfgfile.h"
29
#include "admin.h"
Marvin Scholz's avatar
Marvin Scholz committed
30
#include "common/httpp/httpp.h"
31
#include "common/httpp/encoding.h"
Michael Smith's avatar
Michael Smith committed
32

33
34
#define CLIENT_DEFAULT_ADMIN_FORMAT                     ADMIN_FORMAT_TRANSFORMED

Philipp Schafft's avatar
Philipp Schafft committed
35
36
37
38
39
typedef enum _protocol_tag {
    ICECAST_PROTOCOL_HTTP = 0,
    ICECAST_PROTOCOL_SHOUTCAST
} protocol_t;

40
41
42
43
typedef enum _reuse_tag {
    /* do not reuse */
    ICECAST_REUSE_CLOSE = 0,
    /* reuse */
44
45
46
    ICECAST_REUSE_KEEPALIVE,
    /* Upgrade to TLS */
    ICECAST_REUSE_UPGRADETLS
47
48
} reuse_t;

49
struct _client_tag {
50
51
52
    /* mode of operation for this client */
    operation_mode mode;

Michael Smith's avatar
Michael Smith committed
53
    /* the client's connection */
54
    connection_t *con;
55
56
57
58

    /* Reuse this connection ... */
    reuse_t reuse;

Michael Smith's avatar
Michael Smith committed
59
    /* the client's http headers */
60
    http_parser_t *parser;
Jack Moffitt's avatar
Jack Moffitt committed
61

62
63
64
    /* Transfer Encoding if any */
    httpp_encoding_t *encoding;

Philipp Schafft's avatar
Philipp Schafft committed
65
66
67
    /* protocol client uses */
    protocol_t protocol;

68
69
    /* http response code for this client */
    int respcode;
Jack Moffitt's avatar
Jack Moffitt committed
70

Philipp Schafft's avatar
Philipp Schafft committed
71
    /* admin command if any. ADMIN_COMMAND_ERROR if not an admin command. */
72
    admin_command_id_t admin_command;
Philipp Schafft's avatar
Philipp Schafft committed
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

    /* authentication instances we still need to go thru */
    struct auth_stack_tag *authstack;

    /* Client username */
    char *username;

    /* Client password */
    char *password;

    /* Client role */
    char *role;

    /* active ACL, set as soon as the client is authenticated */
    acl_t *acl;
88

89
90
    /* is client getting intro data */
    long intro_offset;
Karl Heyes's avatar
Karl Heyes committed
91

Karl Heyes's avatar
Karl Heyes committed
92
93
94
    /* where in the queue the client is */
    refbuf_t *refbuf;

95
    /* position in first buffer */
96
    unsigned int pos;
97

98
99
100
    /* auth used for this client */
    struct auth_tag *auth;

101
102
    /* Format-handler-specific data for this client */
    void *format_data;
103
104
105

    /* function to call to release format specific resources */
    void (*free_client_data)(struct _client_tag *client);
Karl Heyes's avatar
Karl Heyes committed
106

107
108
109
    /* write out data associated with client */
    int (*write_to_client)(struct _client_tag *client);

Karl Heyes's avatar
Karl Heyes committed
110
111
    /* function to check if refbuf needs updating */
    int (*check_buffer)(struct source_tag *source, struct _client_tag *client);
112
};
Jack Moffitt's avatar
Jack Moffitt committed
113

114
int client_create (client_t **c_ptr, connection_t *con, http_parser_t *parser);
Jack Moffitt's avatar
Jack Moffitt committed
115
void client_destroy(client_t *client);
116
void client_send_error_by_id(client_t *client, icecast_error_id_t id);
117
void client_send_101(client_t *client, reuse_t reuse);
118
void client_send_204(client_t *client);
119
void client_send_426(client_t *client, reuse_t reuse);
120
admin_format_t client_get_admin_format_by_content_negotiation(client_t *client);
121
int client_send_bytes (client_t *client, const void *buf, unsigned len);
122
int client_read_bytes (client_t *client, void *buf, unsigned len);
Karl Heyes's avatar
Karl Heyes committed
123
void client_set_queue (client_t *client, refbuf_t *refbuf);
Jack Moffitt's avatar
Jack Moffitt committed
124
125

#endif  /* __CLIENT_H__ */