source: roaraudio/roard/include/client.h @ 5823:f9f70dbaa376

//client.h:

/*
 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2013
 *
 *  This file is part of roard a part of RoarAudio,
 *  a cross-platform sound system for both, home and professional use.
 *  See README for details.
 *
 *  This file is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 3
 *  as published by the Free Software Foundation.
 *
 *  RoarAudio is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this software; see the file COPYING.  If not, write to
 *  the Free Software Foundation, 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 *
 */

#ifndef _CLIENT_H_
#define _CLIENT_H_

/*
 Defined in <roaraudio/client.h>


#define ROAR_BUFFER_NAME 80

#define ROAR_CLIENTS_MAX 64
#define ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT 4

struct roar_client {
 int fh; /-* controll connection *-/
// int last_stream; /-* id of the last stream created *-/
 char name[ROAR_BUFFER_NAME];
 int pid;
 char host[ROAR_BUFFER_NAME];
 int execed;
 int streams[ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT];
} * g_clients[ROAR_CLIENTS_MAX];
*/

// access level:
enum roard_client_acclev {
 ACCLEV_ERROR    = -1, // used as erorr return value.
 ACCLEV_NONE     =  0, // only very basic commands like NOOP and IDENTIFY
 ACCLEV_IDENTED,       // same as NONE but INDENTIFY worked.
 ACCLEV_CONCTL,        // only allowed to do basic connection things.
 ACCLEV_GUEST,         // guest connection (read only)
 ACCLEV_USER,          // normal user connect (read write)
 ACCLEV_PWRUSER,       // power user, may access other user's clients
 ACCLEV_ALL            // full (admin) access (read write ctl)
};

struct roar_client_nsubscribe {
 struct roar_subscriber * sub;
};

extern struct roar_client_server {
 struct roar_client _client;
 size_t blockc;
 struct roar_subscriber ** waits;
 enum roard_client_acclev acclev;
 // may be used by protocols working directly on big data blocks to buffer a bit:
 struct roar_buffer * inbuf, * outbuf;
 void * protoinst;
} * g_clients[ROAR_CLIENTS_MAX];

struct roard_listen;

struct roard_proto {
 int proto;
 int subsystems;
 const char * description;
 struct roar_dl_lhandle * lhandle;
 int (*new_client)(int client, struct roar_vio_calls * vio, struct roard_listen * lsock);
 int (*delete_client)(int client);
 int (*check_client)(int client, struct roar_vio_calls * vio);
 int (*flush_client)(int client, struct roar_vio_calls * vio);
 int (*flushed_client)(int client, struct roar_vio_calls * vio);
};

enum roard_proto_type {
 ROARD_PROTO_TYPE_BUILDIN = 0,
// ROARD_PROTO_TYPE_ROARDPROTO = 1, // old. Removed in 1.0beta6.
 ROARD_PROTO_TYPE_COMMON = 2
};

struct roard_proto_handle {
 int proto;
 struct roar_dl_lhandle * lhandle;
 enum roard_proto_type type;
 const struct roar_keyval * para;
 ssize_t paralen;
 union {
  int buildin; // dummy
  const struct roar_dl_proto * common;
 } impl;
};

#define MAX_PROTOS 16

// basic functions
int clients_init       (void);
int clients_free       (void);
int clients_new        (void);
int clients_new_from_fh(int fh, int proto, int byteorder, int update_nnode);
int clients_new_from_fh2(int fh, int proto, int byteorder,
                         int update_nnode,
                         struct roard_listen * lsock, struct sockaddr * sockaddr, socklen_t addrlen);
int clients_delete     (int id);
int clients_close      (int id, int nocheck_exec);
int clients_set_fh     (int id, int    fh);
int clients_set_pid    (int id, int    pid);
int clients_set_uid    (int id, int    uid);
int clients_set_gid    (int id, int    gid);
int clients_set_name   (int id, const char * name);
int clients_set_proto  (int id, int    proto);
int clients_get        (int id, struct roar_client ** client);
int clients_get_server (int id, struct roar_client_server ** client);
int clients_get_fh     (int id);

int clients_block      (int id, int unblock);

// network functions
int clients_check_all  (void);
int clients_check      (int id);
int clients_flush      (int id);
int clients_send_mon   (struct roar_audio_info * sa);
int clients_send_filter(struct roar_audio_info * sa);

int clients_add_output (int id, struct roar_buffer ** buf);

// proto support
const struct roard_proto_handle * clients_get_protohandle(const int proto);
int clients_register_proto_common(const struct roar_dl_proto * proto, struct roar_dl_lhandle * lhandle);
int clients_unregister_proto(int proto);
void print_protolist        (enum output_format format);

// stream functions
int client_stream_exec   (int client, int stream);
int client_stream_set_fh (int client, int stream, int fh);
int client_stream_add    (int client, int stream);
int client_stream_delete (int client, int stream);
int client_stream_move   (int client, int stream);

// notify thingys
int  clients_wait    (int client, struct roar_event * events, size_t num);
void clients_ncb_wait(struct roar_notify_core * core, struct roar_event * event, void * userdata);

// acclev:
enum roard_client_acclev clients_str2acclev(const char * acclev);
const char * clients_acclev2str(const enum roard_client_acclev acclev);

#endif

//ll