obex.h

Go to the documentation of this file.

/*
 Copyright (c) 2007, Forkbeard team

 All rights reserved.

 Licensed under BSD license. See License.txt
*/


#ifndef __OBEX_H__
#define __OBEX_H__

#ifdef __cplusplus
extern "C" {
#endif


typedef enum _ObexPacketHeader
{
    OBEX_PACKET_HEADER_UNKNOWN      = 0,

    OBEX_PACKET_HEADER_NAME         = 0x01,

    OBEX_PACKET_HEADER_DESCRIPTION  = 0x05,

    OBEX_PACKET_HEADER_TYPE         = 0x42,

    /* Time in ISO 8601 format. Preferred time format. OPTIONAL */
    OBEX_PACKET_HEADER_TIME         = 0x44,

    /* Name of the service the operation is targeted to. Used with CONNECT, PUT.
       When used, must be the first header in the packet. Cannot be used together with CONNECTION_ID header in request, 
       but can be used together with CONNECTION_ID header in response. */
    OBEX_PACKET_HEADER_TARGET       = 0x46,

    OBEX_PACKET_HEADER_HTTP         = 0x47,

    OBEX_PACKET_HEADER_BODY         = 0x48,
    OBEX_PACKET_HEADER_EOF_BODY     = 0x49,

    OBEX_PACKET_HEADER_WHO          = 0x4A,

    OBEX_PACKET_HEADER_APP_PARAMS   = 0x4C,

    OBEX_PACKET_HEADER_AUTH_CHG     = 0x4D,

    OBEX_PACKET_HEADER_AUTH_RES     = 0x4E,

    OBEX_PACKET_HEADER_WAN_UUID     = 0x50,

    OBEX_PACKET_HEADER_CLASS        = 0x51,

    OBEX_PACKET_HEADER_SESSION_PARAM = 0x52,

    OBEX_PACKET_HEADER_SESSION_SEG  = 0x93,

    OBEX_PACKET_HEADER_COUNT        = 0xC0,

    OBEX_PACKET_HEADER_LENGTH       = 0xC3,

    OBEX_PACKET_HEADER_TIME2        = 0xC4,

    OBEX_PACKET_HEADER_CONNECTION_ID = 0xCB,

    OBEX_PACKET_HEADER_CREATOR       = 0xCF,

} ObexPacketHeader;

typedef enum _ObexPacketOperation
{
    OBEX_PACKET_OPERATION_UNKNOWN       = 0,

    OBEX_PACKET_OPERATION_CONNECT       = 0x80,
    OBEX_PACKET_OPERATION_DISCONNECT    = 0x81,

    OBEX_PACKET_OPERATION_PUT           = 0x02,
    OBEX_PACKET_OPERATION_PUT_FINAL     = 0x82,

    OBEX_PACKET_OPERATION_GET           = 0x03,
    OBEX_PACKET_OPERATION_GET_FINAL     = 0x83,

    OBEX_PACKET_OPERATION_SET_PATH      = 0x85,

    OBEX_PACKET_OPERATION_SESSION       = 0x87,

    OBEX_PACKET_OPERATION_ABORT         = 0xFF,    
} ObexPacketOperation;

typedef enum _ObexResponseCode
{
    OBEX_RESPONSE_CODE_UNKNOWN       = 0,
    OBEX_RESPONSE_CODE_CONTINUE      = 0x10,    

    OBEX_RESPONSE_CODE_SUCCESS       = 0x20,    

    OBEX_RESPONSE_CODE_BAD_REQUEST    = 0x40,    
    OBEX_RESPONSE_CODE_UNAUTHORIZED   = 0x41,    
    OBEX_RESPONSE_CODE_PAYREQ         = 0x42,    
    OBEX_RESPONSE_CODE_FORBIDDEN      = 0x43,    
    OBEX_RESPONSE_CODE_NOTFOUND       = 0x44,    
    OBEX_RESPONSE_CODE_BAD_METHOD     = 0x45,    
    OBEX_RESPONSE_CODE_UNACCEPTABLE   = 0x46,    
    OBEX_RESPONSE_CODE_PROXY_AUTH_REQ = 0x47,    
    OBEX_RESPONSE_CODE_REQ_TIMEOUT    = 0x48,    
    OBEX_RESPONSE_CODE_CONFLICT       = 0x49,    
    OBEX_RESPONSE_CODE_GONE           = 0x4A,    
    OBEX_RESPONSE_CODE_LENGTH_REQ     = 0x4B,    
    OBEX_RESPONSE_CODE_PRECON_FAILED  = 0x4C,    
    OBEX_RESPONSE_CODE_ENTITY_TOO_LARGE       = 0x4D,    
    OBEX_RESPONSE_CODE_URL_TOO_LARGE          = 0x4E,    
    OBEX_RESPONSE_CODE_UNSUPPORTED_MEDIA_TYPE = 0x4F,    

    OBEX_RESPONSE_CODE_INTERNAL_SERVER_ERROR    = 0x50,    
    OBEX_RESPONSE_CODE_NOT_IMPLEMENTED          = 0x51,    
    OBEX_RESPONSE_CODE_BAD_GATEWAY              = 0x52,    
    OBEX_RESPONSE_CODE_SERVICE_UNAVAILABLE      = 0x53,    
    OBEX_RESPONSE_CODE_GATEWAY_TIMEOUT          = 0x54,    
    OBEX_RESPONSE_CODE_HTTP_VERSION_UNSUPPORTED = 0x55,    

    OBEX_RESPONSE_CODE_DATABASE_FULL    = 0x60,     
    OBEX_RESPONSE_CODE_DATABASE_LOCKED  = 0x61,     

} ObexResponseCode;

typedef enum _ObexSessionFlags
{
    OBEX_SESSION_FLAGS_UNKNOWN          = 0,
    OBEX_SESSION_FLAGS_AUTHENTICATE     = 1,    
} ObexSessionFlags;

/* Obex error codes. */
#define OBEX_ERROR_SUCCESS                  0
#define OBEX_ERROR_UNDEFINED                1
#define OBEX_ERROR_AUTHENTICATION_FAILED    2
#define OBEX_ERROR_INVALID_PARAMETER        3
#define OBEX_ERROR_OUT_OF_MEMORY            4
#define OBEX_ERROR_UNSUPPORTED              5
#define OBEX_ERROR_PACKET_TOO_LARGE         6
#define OBEX_ERROR_INVALID_PACKET           7

#define OBEX_PACKET_MAXIMUM_SIZE         65535

/* Obex structures. */

/* Types. */
typedef unsigned char   byte;
typedef unsigned short  word;
typedef unsigned int    dword;

typedef struct _BTConnection        BTConnection;

typedef struct _ObexPacket          ObexPacket;

typedef struct _ObexSession         ObexSession;

typedef struct _ObexTLVPacket       ObexTLVPacket;

typedef struct _TagLengthValue
{
    byte    tag;
    byte    length;
    byte    value[253];
} TLV;

typedef struct _BluetoothAddress
{
    union 
    {
        unsigned __int64    address;
        unsigned char       bytes[6];
    };
} BluetoothAddress;


#ifndef INITGUID
#define INITGUID
#endif
#include <guiddef.h>

typedef GUID OBEX_UUID;

#ifndef DEFINE_OBEX_UUID
#define DEFINE_OBEX_UUID(name, l )    DEFINE_GUID( name, l, 0x0000, 0x1000, 0x80, 0x00, 0x00, 0x80, 0x5F, 0x9B, 0x34, 0xFB );
#endif // DEFINE_OBEX_UUID

DEFINE_OBEX_UUID  ( SERVICE_OBEX     , 0x00000008 )
DEFINE_OBEX_UUID  ( SERVICE_OBEX_OPP , 0x00001105 )
DEFINE_OBEX_UUID  ( SERVICE_OBEX_FTP , 0x00001106 )
DEFINE_OBEX_UUID  ( SERVICE_OBEX_SYNC, 0x00001104 )

/* Some targets for connect. */
DEFINE_GUID  ( SERVICE_TARGET_FOLDER_BROWSING  , 0xF9EC7BC4, 0x953C, 0x11D2, 0x98, 0x4E, 0x52, 0x54, 0x00, 0xDC, 0x9E, 0x09 );
DEFINE_GUID  ( SERVICE_TARGET_IRMC_SYNC        , 0x49524D43, 0x2D53, 0x594E, 0x43, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 );
DEFINE_GUID  ( SERVICE_TARGET_SYNCML_SYNC      , 0x53594e43, 0x4d4c, 0x2d53, 0x59, 0x4e, 0x43, 0x00, 0x00, 0x00, 0x00, 0x00 );


/* Function prototypes for callbacks. */

typedef int (*AuthenticationResponseFunc)( void* appData, byte* authResponse, word* authSize );


/* Connection functions.  */


int createBTConnection( BTConnection** connection, const BluetoothAddress* device, const BluetoothAddress* address, const OBEX_UUID* service, byte channel );

int closeBTConnection( BTConnection* connection );

int readBTConnection( BTConnection* connection, dword *size, void* data );

int writeBTConnection( BTConnection* connection, dword *size, void* data );

int peekBTConnection( BTConnection* connection, dword* available );


/* Obex session functions.  */

int obexSessionOpen( ObexSession** session, BTConnection* connection, ObexPacket* request, ObexPacket** response ,const OBEX_UUID* target,
                     AuthenticationResponseFunc authFunc, void* appData , ObexSessionFlags flags );

int obexSessionClose( ObexSession* session );

int obexSessionSend( ObexSession* session, ObexPacket* request, ObexPacket** response );

word obexSessionGetMaximumRequestSize( ObexSession* session );

dword obexSessionGetConnectionId( ObexSession* session );

int obexSessionGetConnectionTarget( ObexSession* session , OBEX_UUID *uuid);

/* Obex packet functions. */

int obexPacketCreate( ObexPacket** packet, ObexPacketOperation operation, byte flags );

int obexPacketAddHeader( ObexPacket* packet, ObexPacketHeader header, word size, void* data );

int obexPacketDestroy( ObexPacket* packet );

/* Packet query functions. */

int  obexPacketHasHeader( ObexPacket* packet, ObexPacketHeader header, word* headerSize );

byte obexPacketGetId( ObexPacket* packet );

word obexPacketGetSize( ObexPacket* packet );

int obexPacketGetHeaderData( ObexPacket* packet, ObexPacketHeader header, void* outData );

int obexPacketClear( ObexPacket* packet, ObexPacketOperation operation, byte flags );

word obexPacketGetSizeLeft( ObexSession* session, ObexPacket* packet );


int obexPacketAddHeaderUnicode( ObexPacket* packet, ObexPacketHeader header, const wchar_t* string);

int obexPacketAddHeaderAscii( ObexPacket* packet, ObexPacketHeader header, const char* string);

int obexPacketAddHeaderTLV( ObexPacket* packet, ObexPacketHeader header, ObexTLVPacket* tlvPacket );

int obexPacketAddHeaderInt( ObexPacket* packet, ObexPacketHeader header, dword value );

int obexPacketAddHeaderByte( ObexPacket* packet, ObexPacketHeader header, byte value );

int obexPacketAddHeaderUUID( ObexPacket* packet, ObexPacketHeader header, OBEX_UUID value );

int obexPacketAddHeaderBin( ObexPacket* packet, ObexPacketHeader header, word size, byte* bytes );


int obexPacketGetHeaderUnicode( ObexPacket* packet, ObexPacketHeader header, wchar_t* string, int size );

int obexPacketGetHeaderAscii( ObexPacket* packet, ObexPacketHeader header, char* string, int size);

int obexPacketGetHeaderTLV( ObexPacket* packet, ObexPacketHeader header, ObexTLVPacket** tlvPacket);

int obexPacketGetHeaderInt( ObexPacket* packet, ObexPacketHeader header, dword* value );

int obexPacketGetHeaderByte( ObexPacket* packet, ObexPacketHeader header, byte* value );

int obexPacketGetHeaderUUID( ObexPacket* packet, ObexPacketHeader header, OBEX_UUID* value );

int obexPacketGetHeaderBin( ObexPacket* packet, ObexPacketHeader header, word* size, byte* bytes );

ObexResponseCode obexResponseCode( byte packetId, int* finalBitSet );


/* tag-length-value triplet functions.  Currently not implemented and cause linker error if used. */

int  obexTLVCreate( ObexTLVPacket** tlvPacket );

int  obexTLVDestroy( ObexTLVPacket* tlvPacket );

int  obexTLVAddValue( ObexTLVPacket* tlvPacket, TLV *tlv );

byte obexTLVGetCount( ObexTLVPacket* tlvPacket );

word obexTLVGetSize( ObexTLVPacket* tlvPacket );

int  obexTLVGetValue( ObexTLVPacket* tlvPacket, byte index, TLV *tlv );


#ifdef __cplusplus
"}"
#endif

#endif /* __OBEX_H__  */

// End of file  

---