client.h 2.62 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).
Philipp Schafft's avatar
Philipp Schafft committed
11
 * Copyright 2011-2014, Philipp "ph3-der-loewe" Schafft <lion@lion.leolix.org>,
12 13
 */

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

Michael Smith's avatar
Michael Smith committed
22
#include "connection.h"
Michael Smith's avatar
Michael Smith committed
23
#include "refbuf.h"
Philipp Schafft's avatar
Philipp Schafft committed
24
#include "acl.h"
Michael Smith's avatar
Michael Smith committed
25
#include "httpp/httpp.h"
Michael Smith's avatar
Michael Smith committed
26

Philipp Schafft's avatar
Philipp Schafft committed
27 28 29 30 31
typedef enum _protocol_tag {
    ICECAST_PROTOCOL_HTTP = 0,
    ICECAST_PROTOCOL_SHOUTCAST
} protocol_t;

Jack Moffitt's avatar
Jack Moffitt committed
32 33
typedef struct _client_tag
{
Michael Smith's avatar
Michael Smith committed
34
    /* the client's connection */
35
    connection_t *con;
Michael Smith's avatar
Michael Smith committed
36
    /* the client's http headers */
37
    http_parser_t *parser;
Jack Moffitt's avatar
Jack Moffitt committed
38

Philipp Schafft's avatar
Philipp Schafft committed
39 40 41
    /* protocol client uses */
    protocol_t protocol;

42 43
    /* http response code for this client */
    int respcode;
Jack Moffitt's avatar
Jack Moffitt committed
44

Philipp Schafft's avatar
Philipp Schafft committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
    /* admin command if any. ADMIN_COMMAND_ERROR if not an admin command. */
    int admin_command;

    /* 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;
62

63 64
    /* is client getting intro data */
    long intro_offset;
Karl Heyes's avatar
Karl Heyes committed
65

Karl Heyes's avatar
Karl Heyes committed
66 67 68
    /* where in the queue the client is */
    refbuf_t *refbuf;

69
    /* position in first buffer */
70
    unsigned int pos;
71

72 73 74
    /* auth used for this client */
    struct auth_tag *auth;

75 76
    /* Format-handler-specific data for this client */
    void *format_data;
77 78 79

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

81 82 83
    /* write out data associated with client */
    int (*write_to_client)(struct _client_tag *client);

Karl Heyes's avatar
Karl Heyes committed
84 85 86
    /* function to check if refbuf needs updating */
    int (*check_buffer)(struct source_tag *source, struct _client_tag *client);

Jack Moffitt's avatar
Jack Moffitt committed
87 88
} client_t;

89
int client_create (client_t **c_ptr, connection_t *con, http_parser_t *parser);
Jack Moffitt's avatar
Jack Moffitt committed
90
void client_destroy(client_t *client);
91
void client_send_error(client_t *client, int status, int plain, const char *message);
92
void client_send_100(client_t *client);
93
int client_send_bytes (client_t *client, const void *buf, unsigned len);
94
int client_read_bytes (client_t *client, void *buf, unsigned len);
Karl Heyes's avatar
Karl Heyes committed
95
void client_set_queue (client_t *client, refbuf_t *refbuf);
Jack Moffitt's avatar
Jack Moffitt committed
96 97

#endif  /* __CLIENT_H__ */