#include <inttypes.h>
#include <sys/socket.h>
#include <openobex/obex_const.h>
Defines | |
#define | OPENOBEX_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c)) |
Typedefs | |
typedef void * | obex_t |
typedef void * | obex_object_t |
typedef void(* | obex_event_t )(obex_t *handle, obex_object_t *obj, int mode, int event, int obex_cmd, int obex_rsp) |
Functions | |
obex_t * | OBEX_Init (int transport, obex_event_t eventcb, unsigned int flags) |
Initialize OBEX. | |
void | OBEX_Cleanup (obex_t *self) |
Close down an OBEX instance. | |
void | OBEX_SetUserData (obex_t *self, void *data) |
Set userdata of an OBEX handle. | |
void * | OBEX_GetUserData (obex_t *self) |
Read the userdata from an OBEX handle. | |
void | OBEX_SetUserCallBack (obex_t *self, obex_event_t eventcb, void *data) |
Change user callback on an OBEX handle. | |
int | OBEX_SetTransportMTU (obex_t *self, uint16_t mtu_rx, uint16_t mtu_tx_max) |
Set MTU to be used for receive and transmit. | |
int | OBEX_GetFD (obex_t *self) |
Get FD. | |
int | OBEX_RegisterCTransport (obex_t *self, obex_ctrans_t *ctrans) |
Register a custom transport. | |
void | OBEX_SetCustomData (obex_t *self, void *data) |
Set customdata of an OBEX handle. | |
void * | OBEX_GetCustomData (obex_t *self) |
Read the customdata from an OBEX handle. | |
int | OBEX_TransportConnect (obex_t *self, struct sockaddr *saddr, int addlen) |
Try to connect to peer. | |
int | OBEX_TransportDisconnect (obex_t *self) |
Disconnect transport. | |
int | OBEX_CustomDataFeed (obex_t *self, uint8_t *inputbuf, int actual) |
Feed OBEX with data when using a custom transport. | |
int | OBEX_HandleInput (obex_t *self, int timeout) |
Let the OBEX parser do some work. | |
int | OBEX_ServerRegister (obex_t *self, struct sockaddr *saddr, int addrlen) |
Start listening for incoming connections. | |
obex_t * | OBEX_ServerAccept (obex_t *server, obex_event_t eventcb, void *data) |
Accept an incoming connection. | |
int | OBEX_Request (obex_t *self, obex_object_t *object) |
Start a request (as client). | |
int | OBEX_CancelRequest (obex_t *self, int nice) |
Cancel an ongoing operation. | |
int | OBEX_SuspendRequest (obex_t *self, obex_object_t *object) |
Suspend transfer of an object. | |
int | OBEX_ResumeRequest (obex_t *self) |
Resume transfer of an object. | |
obex_object_t * | OBEX_ObjectNew (obex_t *self, uint8_t cmd) |
Create a new OBEX Object. | |
int | OBEX_ObjectDelete (obex_t *self, obex_object_t *object) |
Delete an OBEX object. | |
int | OBEX_ObjectAddHeader (obex_t *self, obex_object_t *object, uint8_t hi, obex_headerdata_t hv, uint32_t hv_size, unsigned int flags) |
Attach a header to an object. | |
int | OBEX_ObjectGetNextHeader (obex_t *self, obex_object_t *object, uint8_t *hi, obex_headerdata_t *hv, uint32_t *hv_size) |
Get next available header from an object. | |
int | OBEX_ObjectReParseHeaders (obex_t *self, obex_object_t *object) |
Allow the user to parse again the rx headers. | |
int | OBEX_ObjectSetRsp (obex_object_t *object, uint8_t rsp, uint8_t lastrsp) |
Sets the response to a received request. | |
int | OBEX_ObjectGetNonHdrData (obex_object_t *object, uint8_t **buffer) |
Get any data which was before headers. | |
int | OBEX_ObjectSetNonHdrData (obex_object_t *object, const uint8_t *buffer, unsigned int len) |
Set data to send before headers. | |
int | OBEX_ObjectSetHdrOffset (obex_object_t *object, unsigned int offset) |
Set headeroffset. | |
int | OBEX_ObjectReadStream (obex_t *self, obex_object_t *object, const uint8_t **buf) |
Read data from body stream. | |
int | OBEX_ObjectGetCommand (obex_t *self, obex_object_t *object) |
Get the OBEX commmand of an object. | |
int | OBEX_UnicodeToChar (uint8_t *c, const uint8_t *uc, int size) |
Simple unicode to char function. | |
int | OBEX_CharToUnicode (uint8_t *uc, const uint8_t *c, int size) |
Simple char to unicode function. | |
char * | OBEX_ResponseToString (int rsp) |
Return a human understandable string from a response-code. | |
char * | OBEX_GetResponseMessage (obex_t *self, int rsp) |
Return a human understandable string from a response-code. | |
int | TcpOBEX_ServerRegister (obex_t *self, struct sockaddr *addr, int addrlen) |
Start listening for incoming TCP connections. | |
int | TcpOBEX_TransportConnect (obex_t *self, struct sockaddr *addr, int addrlen) |
Connect TCP transport. | |
int | InOBEX_ServerRegister (obex_t *self) |
Start listening for incoming connections. | |
int | InOBEX_TransportConnect (obex_t *self, struct sockaddr *saddr, int addrlen) |
Connect Inet transport (deprecated). | |
int | IrOBEX_ServerRegister (obex_t *self, const char *service) |
Start listening for incoming connections. | |
int | IrOBEX_TransportConnect (obex_t *self, const char *service) |
Connect Irda transport. | |
int | FdOBEX_TransportSetup (obex_t *self, int rfd, int wfd, int mtu) |
int | OBEX_FindInterfaces (obex_t *self, obex_interface_t **intf) |
Get a list of OBEX interfaces on the system. | |
int | OBEX_InterfaceConnect (obex_t *self, obex_interface_t *intf) |
Connect USB interface. | |
void | OBEX_FreeInterfaces (obex_t *self) |
Copyright (C) 1999-2000 Dag Brattli <dagb@cs.uit.no> Copyright (C) 1999-2000 Pontus Fuchs <pontus.fuchs@tactel.se> Copyright (C) 2001-2002 Jean Tourrilhes <jt@hpl.hp.com> Copyright (C) 2002-2006 Marcel Holtmann <marcel@holtmann.org> Copyright (C) 2002-2008 Christian W. Zuckschwerdt <zany@triq.net> Copyright (C) 2002 Dmitry Kasatkin <dmitry.kasatkin@nokia.com> Copyright (C) 2005 Herton Ronaldo Krzesinski <herton@conectiva.com.br> Copyright (C) 2005-2008 Alex Kanavin <ak@sensi.org> Copyright (C) 2006 Johan Hedberg <johan.hedberg@nokia.com> Copyright (C) 2007-2008 Hendrik Sattler <post@hendrik-sattler.de>
OpenOBEX 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 program 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 OpenOBEX. If not, see <http://www.gnu.org/>.
#define OPENOBEX_VERSION | ( | a, | |||
b, | |||||
c | ) | (((a) << 16) + ((b) << 8) + (c)) |
typedef void(* obex_event_t)(obex_t *handle, obex_object_t *obj, int mode, int event, int obex_cmd, int obex_rsp) |
typedef void* obex_object_t |
typedef void* obex_t |
int FdOBEX_TransportSetup | ( | obex_t * | self, | |
int | rfd, | |||
int | wfd, | |||
int | mtu | |||
) |
int InOBEX_ServerRegister | ( | obex_t * | self | ) |
Start listening for incoming connections.
self | OBEX handle |
This function is deprecated, use TcpOBEX_ServerRegister() instead.
int InOBEX_TransportConnect | ( | obex_t * | self, | |
struct sockaddr * | saddr, | |||
int | addrlen | |||
) |
Connect Inet transport (deprecated).
self | OBEX handle | |
saddr | Address to connect to | |
addrlen | Length of address |
This function is deprecated, use TcpOBEX_TransportConnect() instead.
int IrOBEX_ServerRegister | ( | obex_t * | self, | |
const char * | service | |||
) |
Start listening for incoming connections.
self | OBEX handle | |
service | Service to bind to. |
int IrOBEX_TransportConnect | ( | obex_t * | self, | |
const char * | service | |||
) |
Connect Irda transport.
self | OBEX handle | |
service | IrIAS service name to connect to |
int OBEX_CancelRequest | ( | obex_t * | self, | |
int | nice | |||
) |
Cancel an ongoing operation.
self | OBEX handle | |
nice | If true an OBEX Abort will be sent if beeing client or OBEX_RSP_UNAUTHORIZED as reponse if beeing server. |
int OBEX_CharToUnicode | ( | uint8_t * | uc, | |
const uint8_t * | c, | |||
int | size | |||
) |
Simple char to unicode function.
uc | Destination (unicode) | |
c | Source (char) | |
size | Length of destination buffer, at least twice the size of source |
void OBEX_Cleanup | ( | obex_t * | self | ) |
Close down an OBEX instance.
self | OBEX handle |
int OBEX_CustomDataFeed | ( | obex_t * | self, | |
uint8_t * | inputbuf, | |||
int | actual | |||
) |
Feed OBEX with data when using a custom transport.
self | OBEX handle | |
inputbuf | Pointer to custom data | |
actual | Length of buffer |
int OBEX_FindInterfaces | ( | obex_t * | self, | |
obex_interface_t ** | interfaces | |||
) |
Get a list of OBEX interfaces on the system.
self | OBEX handle | |
interfaces | A list of OBEX interfaces |
void OBEX_FreeInterfaces | ( | obex_t * | self | ) |
void* OBEX_GetCustomData | ( | obex_t * | self | ) |
Read the customdata from an OBEX handle.
self | OBEX handle |
int OBEX_GetFD | ( | obex_t * | self | ) |
Get FD.
self | OBEX handle |
The returned filehandle can be used to do select() on, before calling OBEX_HandleInput()
There is one subtelty about this function. When the OBEX connection is established, it returns the connection filedescriptor, while for an unconnected server it will return the listening filedescriptor. This mean that after receiving an incomming connection, you need to call this function again.
char* OBEX_GetResponseMessage | ( | obex_t * | self, | |
int | rsp | |||
) |
Return a human understandable string from a response-code.
self | OBEX handle | |
rsp | Response code. |
void* OBEX_GetUserData | ( | obex_t * | self | ) |
Read the userdata from an OBEX handle.
self | OBEX handle |
int OBEX_HandleInput | ( | obex_t * | self, | |
int | timeout | |||
) |
Let the OBEX parser do some work.
self | OBEX handle | |
timeout | Maximum time to wait in seconds |
When a request has been sent or you are waiting for an incoming server- request you should call this function until the request has finished.
Like select() this function returns -1 on error, 0 on timeout or positive on success.
obex_t* OBEX_Init | ( | int | transport, | |
obex_event_t | eventcb, | |||
unsigned int | flags | |||
) |
Initialize OBEX.
transport | Which transport to use. The following transports are available :
| |
eventcb | Function pointer to your event callback. See obex.h for prototype of this callback. | |
flags | Bitmask of flags. The following flags are available :
|
int OBEX_InterfaceConnect | ( | obex_t * | self, | |
obex_interface_t * | intf | |||
) |
Connect USB interface.
self | OBEX handle | |
intf | USB interface to connect to |
int OBEX_ObjectAddHeader | ( | obex_t * | self, | |
obex_object_t * | object, | |||
uint8_t | hi, | |||
obex_headerdata_t | hv, | |||
uint32_t | hv_size, | |||
unsigned int | flags | |||
) |
Attach a header to an object.
self | OBEX handle | |
object | OBEX object | |
hi | Header identifier | |
hv | Header value | |
hv_size | Header size | |
flags | See obex.h for possible values |
If you want all headers to fit in one packet, use the flag OBEX_FL_FIT_ONE_PACKET on all headers you add to an object.
To stream a body add a body header with hv.bs = NULL and set the flag OBEX_FL_STREAM_START. You will now get OBEX_EV_STREAMEMPTY events as soon as the the parser wants you to feed it with more data.
When you get an OBEX_EV_STREAMEMPTY event give the parser some data by adding a body-header and set the flag OBEX_FL_STREAM_DATA. When you have no more data to send set the flag OBEX_FL_STREAM_DATAEND instead.
After adding a header you are free to do whatever you want with the buffer if you are NOT streaming. If you are streaming you may not touch the buffer until you get another OBEX_EV_STREAMEMPTY or until the request finishes.
The headers will be sent in the order you add them.
int OBEX_ObjectDelete | ( | obex_t * | self, | |
obex_object_t * | object | |||
) |
Delete an OBEX object.
self | OBEX handle | |
object | object to delete. |
int OBEX_ObjectGetCommand | ( | obex_t * | self, | |
obex_object_t * | object | |||
) |
Get the OBEX commmand of an object.
self | OBEX context | |
object | OBEX object (or NULL to access the current object) |
int OBEX_ObjectGetNextHeader | ( | obex_t * | self, | |
obex_object_t * | object, | |||
uint8_t * | hi, | |||
obex_headerdata_t * | hv, | |||
uint32_t * | hv_size | |||
) |
Get next available header from an object.
self | OBEX handle | |
object | OBEX object | |
hi | Pointer to header identifier | |
hv | Pointer to hv | |
hv_size | Pointer to hv_size |
All headers are read-only.
You will get the headers in the received order.
int OBEX_ObjectGetNonHdrData | ( | obex_object_t * | object, | |
uint8_t ** | buffer | |||
) |
Get any data which was before headers.
object | OBEX object | |
buffer | Pointer to a pointer which will point to a read-only buffer |
obex_object_t* OBEX_ObjectNew | ( | obex_t * | self, | |
uint8_t | cmd | |||
) |
Create a new OBEX Object.
self | OBEX handle | |
cmd | command of object |
int OBEX_ObjectReadStream | ( | obex_t * | self, | |
obex_object_t * | object, | |||
const uint8_t ** | buf | |||
) |
Read data from body stream.
self | OBEX handle | |
object | OBEX object | |
buf | A pointer to a pointer which this function will set to a buffer which shall be read (and ONLY read) after this function returns. |
You will now recieve OBEX_EV_STREAMAVAIL events when data is available for you. Call this function to get the data.
Note! When receiving a stream data is not buffered so if you don't call this function when you get an OBEX_EV_STREAMAVAIL event data will be lost.
int OBEX_ObjectReParseHeaders | ( | obex_t * | self, | |
obex_object_t * | object | |||
) |
Allow the user to parse again the rx headers.
self | OBEX handle | |
object | OBEX object |
int OBEX_ObjectSetHdrOffset | ( | obex_object_t * | object, | |
unsigned int | offset | |||
) |
Set headeroffset.
object | OBEX object | |
offset | Desired offset |
int OBEX_ObjectSetNonHdrData | ( | obex_object_t * | object, | |
const uint8_t * | buffer, | |||
unsigned int | len | |||
) |
Set data to send before headers.
object | OBEX object | |
buffer | Data to send | |
len | Length to data |
int OBEX_ObjectSetRsp | ( | obex_object_t * | object, | |
uint8_t | rsp, | |||
uint8_t | lastrsp | |||
) |
Sets the response to a received request.
object | OBEX object | |
rsp | Respose code in non-last packets | |
lastrsp | Response code in last packet |
int OBEX_RegisterCTransport | ( | obex_t * | self, | |
obex_ctrans_t * | ctrans | |||
) |
Register a custom transport.
self | OBEX handle | |
ctrans | Structure with callbacks to transport operations (see obex_const.h for details) |
int OBEX_Request | ( | obex_t * | self, | |
obex_object_t * | object | |||
) |
Start a request (as client).
self | OBEX handle | |
object | Object containing request |
char* OBEX_ResponseToString | ( | int | rsp | ) |
Return a human understandable string from a response-code.
rsp | Response code. |
int OBEX_ResumeRequest | ( | obex_t * | self | ) |
Resume transfer of an object.
self | OBEX handle |
obex_t* OBEX_ServerAccept | ( | obex_t * | server, | |
obex_event_t | eventcb, | |||
void * | data | |||
) |
Accept an incoming connection.
server | OBEX handle | |
eventcb | Event callback for client (use NULL for same as server) | |
data | Userdata for client (use NULL for same as server) |
This function should be called after the library generates an OBEX_EV_ACCEPTHINT event to the user, but before the user start to pull data out of the incomming connection.
Using this function also requires that the OBEX handle was created with the OBEX_FL_KEEPSERVER flag set while calling OBEX_Init().
int OBEX_ServerRegister | ( | obex_t * | self, | |
struct sockaddr * | saddr, | |||
int | addrlen | |||
) |
Start listening for incoming connections.
self | OBEX handle | |
saddr | Local address to bind to | |
addrlen | Length of address |
void OBEX_SetCustomData | ( | obex_t * | self, | |
void * | data | |||
) |
Set customdata of an OBEX handle.
self | OBEX handle | |
data | Custom Transport data |
int OBEX_SetTransportMTU | ( | obex_t * | self, | |
uint16_t | mtu_rx, | |||
uint16_t | mtu_tx_max | |||
) |
Set MTU to be used for receive and transmit.
self | OBEX handle | |
mtu_rx | maximum receive transport packet size | |
mtu_tx_max | maximum transmit transport packet size negociated |
void OBEX_SetUserCallBack | ( | obex_t * | self, | |
obex_event_t | eventcb, | |||
void * | data | |||
) |
Change user callback on an OBEX handle.
self | OBEX handle | |
eventcb | Function pointer to your new event callback. | |
data | Pointer to the new user data to pass to the new callback (optional) |
void OBEX_SetUserData | ( | obex_t * | self, | |
void * | data | |||
) |
Set userdata of an OBEX handle.
self | OBEX handle | |
data | It's all up to you! |
int OBEX_SuspendRequest | ( | obex_t * | self, | |
obex_object_t * | object | |||
) |
Suspend transfer of an object.
self | OBEX handle | |
object | object to suspend (NULL to suspend currently transfered object) |
int OBEX_TransportConnect | ( | obex_t * | self, | |
struct sockaddr * | saddr, | |||
int | addrlen | |||
) |
Try to connect to peer.
self | OBEX handle | |
saddr | Address to connect to | |
addrlen | Length of address |
int OBEX_TransportDisconnect | ( | obex_t * | self | ) |
Disconnect transport.
self | OBEX handle |
int OBEX_UnicodeToChar | ( | uint8_t * | c, | |
const uint8_t * | uc, | |||
int | size | |||
) |
Simple unicode to char function.
c | Destination (char) | |
uc | Source (unicode) | |
size | Length of destination buffer, at least half the size of source |
int TcpOBEX_ServerRegister | ( | obex_t * | self, | |
struct sockaddr * | addr, | |||
int | addrlen | |||
) |
Start listening for incoming TCP connections.
self | OBEX handle | |
addr | Address to bind to (*:650 if NULL) | |
addrlen | Length of address structure |
int TcpOBEX_TransportConnect | ( | obex_t * | self, | |
struct sockaddr * | addr, | |||
int | addrlen | |||
) |
Connect TCP transport.
self | OBEX handle | |
addr | Address to connect to ([::1]:650 if NULL) | |
addrlen | Length of address structure |