summaryrefslogtreecommitdiffstats
path: root/src/syslog_relay.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/syslog_relay.c')
-rw-r--r--src/syslog_relay.c87
1 files changed, 0 insertions, 87 deletions
diff --git a/src/syslog_relay.c b/src/syslog_relay.c
index b908153..a636e6e 100644
--- a/src/syslog_relay.c
+++ b/src/syslog_relay.c
@@ -61,18 +61,6 @@ static syslog_relay_error_t syslog_relay_error(service_error_t err)
61 return SYSLOG_RELAY_E_UNKNOWN_ERROR; 61 return SYSLOG_RELAY_E_UNKNOWN_ERROR;
62} 62}
63 63
64/**
65 * Connects to the syslog_relay service on the specified device.
66 *
67 * @param device The device to connect to.
68 * @param service The service descriptor returned by lockdownd_start_service.
69 * @param client Pointer that will point to a newly allocated
70 * syslog_relay_client_t upon successful return. Must be freed using
71 * syslog_relay_client_free() after use.
72 *
73 * @return SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when
74 * client is NULL, or an SYSLOG_RELAY_E_* error code otherwise.
75 */
76syslog_relay_error_t syslog_relay_client_new(idevice_t device, lockdownd_service_descriptor_t service, syslog_relay_client_t * client) 64syslog_relay_error_t syslog_relay_client_new(idevice_t device, lockdownd_service_descriptor_t service, syslog_relay_client_t * client)
77{ 65{
78 *client = NULL; 66 *client = NULL;
@@ -101,19 +89,6 @@ syslog_relay_error_t syslog_relay_client_new(idevice_t device, lockdownd_service
101 return 0; 89 return 0;
102} 90}
103 91
104/**
105 * Starts a new syslog_relay service on the specified device and connects to it.
106 *
107 * @param device The device to connect to.
108 * @param client Pointer that will point to a newly allocated
109 * syslog_relay_client_t upon successful return. Must be freed using
110 * syslog_relay_client_free() after use.
111 * @param label The label to use for communication. Usually the program name.
112 * Pass NULL to disable sending the label in requests to lockdownd.
113 *
114 * @return SYSLOG_RELAY_E_SUCCESS on success, or an SYSLOG_RELAY_E_* error
115 * code otherwise.
116 */
117syslog_relay_error_t syslog_relay_client_start_service(idevice_t device, syslog_relay_client_t * client, const char* label) 92syslog_relay_error_t syslog_relay_client_start_service(idevice_t device, syslog_relay_client_t * client, const char* label)
118{ 93{
119 syslog_relay_error_t err = SYSLOG_RELAY_E_UNKNOWN_ERROR; 94 syslog_relay_error_t err = SYSLOG_RELAY_E_UNKNOWN_ERROR;
@@ -121,15 +96,6 @@ syslog_relay_error_t syslog_relay_client_start_service(idevice_t device, syslog_
121 return err; 96 return err;
122} 97}
123 98
124/**
125 * Disconnects a syslog_relay client from the device and frees up the
126 * syslog_relay client data.
127 *
128 * @param client The syslog_relay client to disconnect and free.
129 *
130 * @return SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when
131 * client is NULL, or an SYSLOG_RELAY_E_* error code otherwise.
132 */
133syslog_relay_error_t syslog_relay_client_free(syslog_relay_client_t client) 99syslog_relay_error_t syslog_relay_client_free(syslog_relay_client_t client)
134{ 100{
135 if (!client) 101 if (!client)
@@ -146,38 +112,11 @@ syslog_relay_error_t syslog_relay_client_free(syslog_relay_client_t client)
146 return err; 112 return err;
147} 113}
148 114
149/**
150 * Receives data from the service.
151 *
152 * @param client The syslog_relay client
153 * @param data Buffer that will be filled with the data received
154 * @param size Number of bytes to receive
155 * @param received Number of bytes received (can be NULL to ignore)
156 * @param timeout Maximum time in milliseconds to wait for data.
157 *
158 * @return SYSLOG_RELAY_E_SUCCESS on success,
159 * SYSLOG_RELAY_E_INVALID_ARG when client or plist is NULL
160 */
161syslog_relay_error_t syslog_relay_receive(syslog_relay_client_t client, char* data, uint32_t size, uint32_t *received) 115syslog_relay_error_t syslog_relay_receive(syslog_relay_client_t client, char* data, uint32_t size, uint32_t *received)
162{ 116{
163 return syslog_relay_receive_with_timeout(client, data, size, received, 1000); 117 return syslog_relay_receive_with_timeout(client, data, size, received, 1000);
164} 118}
165 119
166/**
167 * Receives data using the given syslog_relay client with specified timeout.
168 *
169 * @param client The syslog_relay client to use for receiving
170 * @param data Buffer that will be filled with the data received
171 * @param size Number of bytes to receive
172 * @param received Number of bytes received (can be NULL to ignore)
173 * @param timeout Maximum time in milliseconds to wait for data.
174 *
175 * @return SYSLOG_RELAY_E_SUCCESS on success,
176 * SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are
177 * invalid, SYSLOG_RELAY_E_MUX_ERROR when a communication error
178 * occurs, or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified
179 * error occurs.
180 */
181syslog_relay_error_t syslog_relay_receive_with_timeout(syslog_relay_client_t client, char* data, uint32_t size, uint32_t *received, unsigned int timeout) 120syslog_relay_error_t syslog_relay_receive_with_timeout(syslog_relay_client_t client, char* data, uint32_t size, uint32_t *received, unsigned int timeout)
182{ 121{
183 syslog_relay_error_t res = SYSLOG_RELAY_E_UNKNOWN_ERROR; 122 syslog_relay_error_t res = SYSLOG_RELAY_E_UNKNOWN_ERROR;
@@ -232,20 +171,6 @@ void *syslog_relay_worker(void *arg)
232 return NULL; 171 return NULL;
233} 172}
234 173
235/**
236 * Starts capturing the syslog of the device using a callback.
237 *
238 * Use syslog_relay_stop_capture() to stop receiving the syslog.
239 *
240 * @param client The syslog_relay client to use
241 * @param callback Callback to receive each character from the syslog.
242 * @param user_data Custom pointer passed to the callback function.
243 *
244 * @return SYSLOG_RELAY_E_SUCCESS on success,
245 * SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are
246 * invalid or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified
247 * error occurs or a syslog capture has already been started.
248 */
249syslog_relay_error_t syslog_relay_start_capture(syslog_relay_client_t client, syslog_relay_receive_cb_t callback, void* user_data) 174syslog_relay_error_t syslog_relay_start_capture(syslog_relay_client_t client, syslog_relay_receive_cb_t callback, void* user_data)
250{ 175{
251 if (!client || !callback) 176 if (!client || !callback)
@@ -273,18 +198,6 @@ syslog_relay_error_t syslog_relay_start_capture(syslog_relay_client_t client, sy
273 return res; 198 return res;
274} 199}
275 200
276/**
277 * Stops capturing the syslog of the device.
278 *
279 * Use syslog_relay_start_capture() to start receiving the syslog.
280 *
281 * @param client The syslog_relay client to use
282 *
283 * @return SYSLOG_RELAY_E_SUCCESS on success,
284 * SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are
285 * invalid or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified
286 * error occurs or a syslog capture has already been started.
287 */
288syslog_relay_error_t syslog_relay_stop_capture(syslog_relay_client_t client) 201syslog_relay_error_t syslog_relay_stop_capture(syslog_relay_client_t client)
289{ 202{
290 if (client->worker) { 203 if (client->worker) {