[0] | 1 | //client.h: |
---|
| 2 | |
---|
[668] | 3 | /* |
---|
[6052] | 4 | * Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2015 |
---|
[668] | 5 | * |
---|
| 6 | * This file is part of roard a part of RoarAudio, |
---|
| 7 | * a cross-platform sound system for both, home and professional use. |
---|
| 8 | * See README for details. |
---|
| 9 | * |
---|
| 10 | * This file is free software; you can redistribute it and/or modify |
---|
| 11 | * it under the terms of the GNU General Public License version 3 |
---|
| 12 | * as published by the Free Software Foundation. |
---|
| 13 | * |
---|
| 14 | * RoarAudio is distributed in the hope that it will be useful, |
---|
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 17 | * GNU General Public License for more details. |
---|
| 18 | * |
---|
| 19 | * You should have received a copy of the GNU General Public License |
---|
| 20 | * along with this software; see the file COPYING. If not, write to |
---|
[3517] | 21 | * the Free Software Foundation, 51 Franklin Street, Fifth Floor, |
---|
| 22 | * Boston, MA 02110-1301, USA. |
---|
[668] | 23 | * |
---|
| 24 | */ |
---|
| 25 | |
---|
[0] | 26 | #ifndef _CLIENT_H_ |
---|
| 27 | #define _CLIENT_H_ |
---|
| 28 | |
---|
| 29 | /* |
---|
| 30 | Defined in <roaraudio/client.h> |
---|
| 31 | |
---|
| 32 | |
---|
| 33 | #define ROAR_BUFFER_NAME 80 |
---|
| 34 | |
---|
| 35 | #define ROAR_CLIENTS_MAX 64 |
---|
| 36 | #define ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT 4 |
---|
| 37 | |
---|
| 38 | struct roar_client { |
---|
| 39 | int fh; /-* controll connection *-/ |
---|
| 40 | // int last_stream; /-* id of the last stream created *-/ |
---|
| 41 | char name[ROAR_BUFFER_NAME]; |
---|
| 42 | int pid; |
---|
| 43 | char host[ROAR_BUFFER_NAME]; |
---|
| 44 | int execed; |
---|
| 45 | int streams[ROAR_CLIENTS_MAX_STREAMS_PER_CLIENT]; |
---|
| 46 | } * g_clients[ROAR_CLIENTS_MAX]; |
---|
| 47 | */ |
---|
| 48 | |
---|
[4467] | 49 | // access level: |
---|
| 50 | enum roard_client_acclev { |
---|
[5146] | 51 | ACCLEV_ERROR = -1, // used as erorr return value. |
---|
| 52 | ACCLEV_NONE = 0, // only very basic commands like NOOP and IDENTIFY |
---|
| 53 | ACCLEV_IDENTED, // same as NONE but INDENTIFY worked. |
---|
| 54 | ACCLEV_CONCTL, // only allowed to do basic connection things. |
---|
| 55 | ACCLEV_GUEST, // guest connection (read only) |
---|
| 56 | ACCLEV_USER, // normal user connect (read write) |
---|
| 57 | ACCLEV_PWRUSER, // power user, may access other user's clients |
---|
| 58 | ACCLEV_ALL // full (admin) access (read write ctl) |
---|
[4467] | 59 | }; |
---|
| 60 | |
---|
[4343] | 61 | struct roar_client_nsubscribe { |
---|
| 62 | struct roar_subscriber * sub; |
---|
| 63 | }; |
---|
| 64 | |
---|
[5192] | 65 | extern struct roar_client_server { |
---|
[4326] | 66 | struct roar_client _client; |
---|
[4343] | 67 | size_t blockc; |
---|
| 68 | struct roar_subscriber ** waits; |
---|
[4467] | 69 | enum roard_client_acclev acclev; |
---|
[4684] | 70 | // may be used by protocols working directly on big data blocks to buffer a bit: |
---|
| 71 | struct roar_buffer * inbuf, * outbuf; |
---|
[5448] | 72 | void * protoinst; |
---|
[4326] | 73 | } * g_clients[ROAR_CLIENTS_MAX]; |
---|
[0] | 74 | |
---|
[4683] | 75 | struct roard_listen; |
---|
| 76 | |
---|
[4678] | 77 | struct roard_proto { |
---|
| 78 | int proto; |
---|
[5275] | 79 | int subsystems; |
---|
| 80 | const char * description; |
---|
[5312] | 81 | struct roar_dl_lhandle * lhandle; |
---|
[4683] | 82 | int (*new_client)(int client, struct roar_vio_calls * vio, struct roard_listen * lsock); |
---|
[5448] | 83 | int (*delete_client)(int client); |
---|
[4678] | 84 | int (*check_client)(int client, struct roar_vio_calls * vio); |
---|
[4686] | 85 | int (*flush_client)(int client, struct roar_vio_calls * vio); |
---|
| 86 | int (*flushed_client)(int client, struct roar_vio_calls * vio); |
---|
[4678] | 87 | }; |
---|
[0] | 88 | |
---|
[5567] | 89 | enum roard_proto_type { |
---|
| 90 | ROARD_PROTO_TYPE_BUILDIN = 0, |
---|
[5640] | 91 | // ROARD_PROTO_TYPE_ROARDPROTO = 1, // old. Removed in 1.0beta6. |
---|
[5567] | 92 | ROARD_PROTO_TYPE_COMMON = 2 |
---|
| 93 | }; |
---|
| 94 | |
---|
| 95 | struct roard_proto_handle { |
---|
| 96 | int proto; |
---|
| 97 | struct roar_dl_lhandle * lhandle; |
---|
| 98 | enum roard_proto_type type; |
---|
[5576] | 99 | const struct roar_keyval * para; |
---|
| 100 | ssize_t paralen; |
---|
[5567] | 101 | union { |
---|
| 102 | int buildin; // dummy |
---|
[5576] | 103 | const struct roar_dl_proto * common; |
---|
[5567] | 104 | } impl; |
---|
| 105 | }; |
---|
| 106 | |
---|
[5591] | 107 | #define MAX_PROTOS 16 |
---|
[4683] | 108 | |
---|
[0] | 109 | // basic functions |
---|
[3737] | 110 | int clients_init (void); |
---|
| 111 | int clients_free (void); |
---|
| 112 | int clients_new (void); |
---|
| 113 | int clients_new_from_fh(int fh, int proto, int byteorder, int update_nnode); |
---|
[5571] | 114 | int clients_new_from_fh2(int fh, int proto, int byteorder, |
---|
| 115 | int update_nnode, |
---|
| 116 | struct roard_listen * lsock, struct sockaddr * sockaddr, socklen_t addrlen); |
---|
[3737] | 117 | int clients_delete (int id); |
---|
[3927] | 118 | int clients_close (int id, int nocheck_exec); |
---|
[3737] | 119 | int clients_set_fh (int id, int fh); |
---|
| 120 | int clients_set_pid (int id, int pid); |
---|
| 121 | int clients_set_uid (int id, int uid); |
---|
| 122 | int clients_set_gid (int id, int gid); |
---|
[5607] | 123 | int clients_set_name (int id, const char * name); |
---|
[3737] | 124 | int clients_set_proto (int id, int proto); |
---|
| 125 | int clients_get (int id, struct roar_client ** client); |
---|
[4468] | 126 | int clients_get_server (int id, struct roar_client_server ** client); |
---|
[3737] | 127 | int clients_get_fh (int id); |
---|
[0] | 128 | |
---|
[4343] | 129 | int clients_block (int id, int unblock); |
---|
| 130 | |
---|
[0] | 131 | // network functions |
---|
| 132 | int clients_check_all (void); |
---|
| 133 | int clients_check (int id); |
---|
[4686] | 134 | int clients_flush (int id); |
---|
[5586] | 135 | int clients_send_mon (struct roar_audio_info * sa); |
---|
| 136 | int clients_send_filter(struct roar_audio_info * sa); |
---|
[0] | 137 | |
---|
[5301] | 138 | int clients_add_output (int id, struct roar_buffer ** buf); |
---|
[4686] | 139 | |
---|
[4679] | 140 | // proto support |
---|
[5567] | 141 | const struct roard_proto_handle * clients_get_protohandle(const int proto); |
---|
[5576] | 142 | int clients_register_proto_common(const struct roar_dl_proto * proto, struct roar_dl_lhandle * lhandle); |
---|
[5275] | 143 | int clients_unregister_proto(int proto); |
---|
| 144 | void print_protolist (enum output_format format); |
---|
[4679] | 145 | |
---|
[0] | 146 | // stream functions |
---|
| 147 | int client_stream_exec (int client, int stream); |
---|
[78] | 148 | int client_stream_set_fh (int client, int stream, int fh); |
---|
[0] | 149 | int client_stream_add (int client, int stream); |
---|
| 150 | int client_stream_delete (int client, int stream); |
---|
[767] | 151 | int client_stream_move (int client, int stream); |
---|
[0] | 152 | |
---|
[4343] | 153 | // notify thingys |
---|
| 154 | int clients_wait (int client, struct roar_event * events, size_t num); |
---|
| 155 | void clients_ncb_wait(struct roar_notify_core * core, struct roar_event * event, void * userdata); |
---|
| 156 | |
---|
[4480] | 157 | // acclev: |
---|
| 158 | enum roard_client_acclev clients_str2acclev(const char * acclev); |
---|
| 159 | const char * clients_acclev2str(const enum roard_client_acclev acclev); |
---|
| 160 | |
---|
[0] | 161 | #endif |
---|
| 162 | |
---|
| 163 | //ll |
---|