1 | //client.h: |
---|
2 | |
---|
3 | /* |
---|
4 | * Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2012 |
---|
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 |
---|
21 | * the Free Software Foundation, 51 Franklin Street, Fifth Floor, |
---|
22 | * Boston, MA 02110-1301, USA. |
---|
23 | * |
---|
24 | */ |
---|
25 | |
---|
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 | |
---|
49 | // access level: |
---|
50 | enum roard_client_acclev { |
---|
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) |
---|
59 | }; |
---|
60 | |
---|
61 | struct roar_client_nsubscribe { |
---|
62 | struct roar_subscriber * sub; |
---|
63 | }; |
---|
64 | |
---|
65 | extern struct roar_client_server { |
---|
66 | struct roar_client _client; |
---|
67 | size_t blockc; |
---|
68 | struct roar_subscriber ** waits; |
---|
69 | enum roard_client_acclev acclev; |
---|
70 | // may be used by protocols working directly on big data blocks to buffer a bit: |
---|
71 | struct roar_buffer * inbuf, * outbuf; |
---|
72 | void * protoinst; |
---|
73 | } * g_clients[ROAR_CLIENTS_MAX]; |
---|
74 | |
---|
75 | struct roard_listen; |
---|
76 | |
---|
77 | struct roard_proto { |
---|
78 | int proto; |
---|
79 | int subsystems; |
---|
80 | const char * description; |
---|
81 | struct roar_dl_lhandle * lhandle; |
---|
82 | int (*new_client)(int client, struct roar_vio_calls * vio, struct roard_listen * lsock); |
---|
83 | int (*delete_client)(int client); |
---|
84 | int (*check_client)(int client, struct roar_vio_calls * vio); |
---|
85 | int (*flush_client)(int client, struct roar_vio_calls * vio); |
---|
86 | int (*flushed_client)(int client, struct roar_vio_calls * vio); |
---|
87 | }; |
---|
88 | |
---|
89 | #define MAX_PROTOS 8 |
---|
90 | extern struct roard_proto g_proto[MAX_PROTOS]; |
---|
91 | |
---|
92 | // basic functions |
---|
93 | int clients_init (void); |
---|
94 | int clients_free (void); |
---|
95 | int clients_new (void); |
---|
96 | int clients_new_from_fh(int fh, int proto, int byteorder, int update_nnode); |
---|
97 | int clients_delete (int id); |
---|
98 | int clients_close (int id, int nocheck_exec); |
---|
99 | int clients_set_fh (int id, int fh); |
---|
100 | int clients_set_pid (int id, int pid); |
---|
101 | int clients_set_uid (int id, int uid); |
---|
102 | int clients_set_gid (int id, int gid); |
---|
103 | int clients_set_name (int id, char * name); |
---|
104 | int clients_set_proto (int id, int proto); |
---|
105 | int clients_get (int id, struct roar_client ** client); |
---|
106 | int clients_get_server (int id, struct roar_client_server ** client); |
---|
107 | int clients_get_fh (int id); |
---|
108 | |
---|
109 | int clients_block (int id, int unblock); |
---|
110 | |
---|
111 | // network functions |
---|
112 | int clients_check_all (void); |
---|
113 | int clients_check (int id); |
---|
114 | int clients_flush (int id); |
---|
115 | int clients_send_mon (struct roar_audio_info * sa, uint32_t pos); |
---|
116 | int clients_send_filter(struct roar_audio_info * sa, uint32_t pos); |
---|
117 | |
---|
118 | int clients_add_output (int id, struct roar_buffer ** buf); |
---|
119 | |
---|
120 | // proto support |
---|
121 | int clients_register_proto (struct roard_proto * proto, struct roar_dl_lhandle * lhandle); |
---|
122 | int clients_unregister_proto(int proto); |
---|
123 | void print_protolist (enum output_format format); |
---|
124 | |
---|
125 | // stream functions |
---|
126 | int client_stream_exec (int client, int stream); |
---|
127 | int client_stream_set_fh (int client, int stream, int fh); |
---|
128 | int client_stream_add (int client, int stream); |
---|
129 | int client_stream_delete (int client, int stream); |
---|
130 | int client_stream_move (int client, int stream); |
---|
131 | |
---|
132 | // notify thingys |
---|
133 | int clients_wait (int client, struct roar_event * events, size_t num); |
---|
134 | void clients_ncb_wait(struct roar_notify_core * core, struct roar_event * event, void * userdata); |
---|
135 | |
---|
136 | // acclev: |
---|
137 | enum roard_client_acclev clients_str2acclev(const char * acclev); |
---|
138 | const char * clients_acclev2str(const enum roard_client_acclev acclev); |
---|
139 | |
---|
140 | #endif |
---|
141 | |
---|
142 | //ll |
---|