xref: /btstack/platform/daemon/src/socket_connection.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2014 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 
39 /*
40  *  socket_connection.h
41  *
42  *  Created by Matthias Ringwald on 6/6/09.
43  */
44 
45 #ifndef SOCKET_CONNECTION_H
46 #define SOCKET_CONNECTION_H
47 
48 #include "btstack_run_loop.h"
49 
50 #include <stdint.h>
51 
52 #if defined __cplusplus
53 extern "C" {
54 #endif
55 
56 /** opaque connection type */
57 typedef struct connection connection_t;
58 
59 /**
60  * Init socket connection module
61  */
62 void socket_connection_init(void);
63 
64 /**
65  * create socket data_source for socket specified by launchd configuration
66  */
67 int socket_connection_create_launchd(void);
68 
69 /**
70  * create socket for incoming tcp connections
71  */
72 int socket_connection_create_tcp(int port);
73 
74 /**
75  * create socket for incoming unix domain connections
76  */
77 int socket_connection_create_unix(char *path);
78 
79 /**
80  * close socket connection to BTdaemon
81  */
82 int socket_connection_close_tcp(connection_t *connection);
83 
84 /**
85  * create TCP socket connection to BTdaemon
86  */
87 connection_t * socket_connection_open_tcp(const char *address, uint16_t port);
88 
89 /**
90  * close TCP socket connection to BTdaemon
91  */
92 int socket_connection_close_tcp(connection_t *connection);
93 
94 /**
95  * create unix socket connection to BTdaemon
96  */
97 connection_t * socket_connection_open_unix(void);
98 
99 /**
100  * close unix connection to BTdaemon
101  */
102 int socket_connection_close_unix(connection_t *connection);
103 
104 /**
105  * set packet handler for all auto-accepted connections
106  * -- packet_callback @return: 0 == OK/NO ERROR
107  */
108 void socket_connection_register_packet_callback( int (*packet_callback)(connection_t *connection, uint16_t packet_type, uint16_t channel, uint8_t *data, uint16_t length) );
109 
110 /**
111  * send HCI packet to single connection
112  */
113 void socket_connection_send_packet(connection_t *connection, uint16_t packet_type, uint16_t channel, uint8_t *data, uint16_t size);
114 
115 /**
116  * send event data to all clients
117  */
118 void socket_connection_send_packet_all(uint16_t type, uint16_t channel, uint8_t *packet, uint16_t size);
119 
120 /**
121  * try to dispatch packet for all "parked" connections.
122  * if dispatch is successful, a connection is added again to run loop
123  */
124 void socket_connection_retry_parked(void);
125 
126 
127 /**
128  * query if at least one connection had to be parked
129  */
130 int  socket_connection_has_parked_connections(void);
131 
132 #if defined __cplusplus
133 }
134 #endif
135 
136 #endif // SOCKET_CONNECTION_H
137