Index

Type the index terms you want to search for in the text input field.
Matching terms will be shown incrementally as you type.
Press Enter to navigate to the target of the first displayed index entry.
Alternatively, Tab to move to the index entry of interest and then press Enter to navigate to that documentation page.
To jump to this page from any other documentation page, press browser-specific shortcut modifiers with i. For example, on IE and Edge this would be Alt-i while on Firefox and Chrome Alt-Shift-i. Other browsers and platforms may differ.

abort
```
OBJECT abort ?headers?
```
Generates a Obex ABORT request.
::obex::Client
await
```
OBJECT await chan action_state
```
Synchronously completes an ongoing operation.
::obex::Client
bodies
```
OBJECT bodies 
```
Get the data content in a request or response
::obex::Helper
bt_uuid
```
bt_uuid 
```
Returns the Bluetooth UUID for the service class for the Object Push Profile.
::obex::opp
clear
```
OBJECT clear 
```
Clears error state if any.
::obex::Client
Client ::obex
Client ::obex::opp
close
```
OBJECT close 
```
Closes an OBEX connection.
::obex::opp::Client
connect
```
OBJECT connect ?headers?
```
Generates a Obex connect request.
::obex::Client
connected
```
OBJECT connected 
```
Returns 1 if the client has an OBEX connection active.
::obex::Client

Client create OBJNAME ?args?
Client new ?args?

::obex::Client

constructor

Server create OBJNAME ?args?
Server new ?args?

::obex::Server

constructor
```
Client create OBJNAME chan ?args?
Client new chan ?args?
```
Creates a client object for the OBEX Object Push Profile.
::obex::opp::Client
disconnect
```
OBJECT disconnect ?headers?
```
Generates a Obex disconnect request.
::obex::Client
exchange_cards
```
OBJECT exchange_cards vcard ?mimetype?
```
Exchanges business cards with a device.
::obex::opp::Client
get
```
OBJECT get ?headers?
```
Generates a Obex GET request.
::obex::Client
get_request
```
OBJECT get_request 
```
::obex::Server
header
```
header subcommand ...
```
A command ensemble.
::obex::core
header decode
```
header decode bytes start
```
Decodes a single binary OBEX header within a packet.
::obex::core
header decoden
```
header decoden bytes start
```
Decodes binary OBEX headers within a packet.
::obex::core
header encode
```
header encode header_name header_value
```
Encodes a single OBEX header.
::obex::core
header encoden
```
header encoden ?args?
```
Encodes multiple OBEX headers.
::obex::core
header find
```
header find headers header_name outvar
```
Gets the value of a header from a list of decoded OBEX headers.
::obex::core
header findall
```
header findall headers header_name
```
Gets the values of headers with a given name in list of decoded OBEX headers
::obex::core
headers
```
OBJECT headers name
```
Retrieves the content of headers of a given type.
::obex::Helper
Helper ::obex
idle
```
OBJECT idle 
```
Returns 1 if another request can be issued, otherwise 0.
::obex::Client
input
```
OBJECT input data
```
Process data from the remote server.
::obex::Client
input
```
OBJECT input data
```
Process data received from a client.
::obex::Server
packet
```
packet subcommand ...
```
A command ensemble.
::obex::core
packet complete
```
packet complete packet
```
Returns 1 if $packet is a complete Obex packet and 0 otherwise.
::obex::core
packet length
```
packet length packet
```
Get the length of a packet.
::obex::core
parameters
```
parameters subcommand ...
```
A command ensemble.
::obex::core
parameters decode
```
parameters decode bytes
```
Decodes a AppParameters header value.
::obex::core
pull_card
```
OBJECT pull_card 
```
Retrieves the business card from the device.
::obex::opp::Client
push_file
```
OBJECT push_file path ?mimetype?
```
Pushes the specified file over the given channel.
::obex::opp::Client
put
```
OBJECT put content ?headers?
```
Generates a Obex PUT request.
::obex::Client
put_delete
```
OBJECT put_delete ?headers?
```
Generates a Obex PUT request to delete an object.
::obex::Client
put_stream
```
OBJECT put_stream chunk ?headers?
```
Generates a Obex PUT request with content provided in chunks.
::obex::Client
request
```
request subcommand ...
```
A command ensemble.
::obex::core
request decode
```
request decode packet outvar
```
Decodes an OBEX request packet received from a client.
::obex::core
request encode
```
request encode op ?args?
```
Encodes an OBEX request.
::obex::core
request encode_setpath
```
request encode_setpath flags constants ?args?
```
Encodes a setpath OBEX request.
::obex::core
reset
```
OBJECT reset 
```
Resets state of the object.
::obex::Client
reset
```
OBJECT reset 
```
Resets state of the object.
::obex::Server
respond
```
OBJECT respond status ?headers?
```
::obex::Server
respond_content
```
OBJECT respond_content content ?headers?
```
Generate a response containing content.
::obex::Server
response
```
OBJECT response 
```
Returns the last response received from the server.
::obex::Client
response
```
response subcommand ...
```
A command ensemble.
::obex::core
response decode
```
response decode packet request_op outvar
```
Decodes a response packet.
::obex::core
Server ::obex
session
```
OBJECT session ?headers?
```
Generate a OBEX session request.
::obex::Client
setpath
```
OBJECT setpath ?headers? ?args?
```
Generates a Obex SETPATH request.
::obex::Client
state
```
OBJECT state 
```
Returns the state of the client.
::obex::Client
state
```
OBJECT state 
```
Returns the state of the server.
::obex::Server
status
```
OBJECT status 
```
Returns the status of the last response received.
::obex::Client
status_detail
```
OBJECT status_detail 
```
Returns the detailed status of the last response received.
::obex::Client