~ubuntu-branches/ubuntu/lucid/libimobiledevice/lucid

/**

 * @file libimobiledevice/libimobiledevice.h

 * @brief Common code and device handling

 * \internal

 *

 * Copyright (c) 2008 Jonathan Beck All Rights Reserved.

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser General Public

 * License as published by the Free Software Foundation; either

 * version 2.1 of the License, or (at your option) any later version.

 * 

 * This library 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

 * Lesser General Public License for more details.

 * 

 * You should have received a copy of the GNU Lesser General Public

 * License along with this library; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA 

 */

 

#ifndef LIBIMOBILEDEVICE_H

#define LIBIMOBILEDEVICE_H

 

#ifdef __cplusplus

extern "C" {

#endif

 

#include <stdint.h>

#include <sys/types.h>

#include <sys/stat.h>

#include <plist/plist.h>

 

/* Error Codes */

#define IDEVICE_E_SUCCESS                0

#define IDEVICE_E_INVALID_ARG           -1

#define IDEVICE_E_UNKNOWN_ERROR         -2

#define IDEVICE_E_NO_DEVICE             -3

#define IDEVICE_E_NOT_ENOUGH_DATA       -4

#define IDEVICE_E_BAD_HEADER            -5

#define IDEVICE_E_SSL_ERROR             -6

 

typedef int16_t idevice_error_t;

 

struct idevice_int;

typedef struct idevice_int *idevice_t;

 

struct idevice_connection_int;

typedef struct idevice_connection_int *idevice_connection_t;

 

/* generic */

void idevice_set_debug_level(int level);

 

/* discovery (events/asynchronous) */

// event type

enum idevice_event_type {

        IDEVICE_DEVICE_ADD = 1,

        IDEVICE_DEVICE_REMOVE

};

 

// event data structure

typedef struct {

        enum idevice_event_type event;

        const char *uuid;

        int conn_type;

} idevice_event_t;

 

// event callback function prototype

typedef void (*idevice_event_cb_t) (const idevice_event_t *event, void *user_data);

 

// functions

idevice_error_t idevice_event_subscribe(idevice_event_cb_t callback, void *user_data);

idevice_error_t idevice_event_unsubscribe();

 

/* discovery (synchronous) */

idevice_error_t idevice_get_device_list(char ***devices, int *count);

idevice_error_t idevice_device_list_free(char **devices);

 

/* device structure creation and destruction */

idevice_error_t idevice_new(idevice_t *device, const char *uuid);

idevice_error_t idevice_free(idevice_t device);

 

/* connection/disconnection */

idevice_error_t idevice_connect(idevice_t device, uint16_t port, idevice_connection_t *connection);

idevice_error_t idevice_disconnect(idevice_connection_t connection);

 

/* communication */

idevice_error_t idevice_connection_send(idevice_connection_t connection, const char *data, uint32_t len, uint32_t *sent_bytes);

idevice_error_t idevice_connection_receive_timeout(idevice_connection_t connection, char *data, uint32_t len, uint32_t *recv_bytes, unsigned int timeout);

idevice_error_t idevice_connection_receive(idevice_connection_t connection, char *data, uint32_t len, uint32_t *recv_bytes);

 

/* misc */

idevice_error_t idevice_get_handle(idevice_t device, uint32_t *handle);

idevice_error_t idevice_get_uuid(idevice_t device, char **uuid);

 

#ifdef __cplusplus

}

#endif

 

#endif