/ 
Net-OBEX-Packet-Headers-0.003
/ Net::OBEX::Packet::Headers::Unicode

NAME

Net::OBEX::Packet::Headers::Unicode - construct "null terminated Unicode text" OBEX headers.

SYNOPSIS

use strict;
use warnings;

use Net::OBEX::Packet::Headers::Unicode;

my $raw = Net::OBEX::Packet::Headers::Unicode->new(
    name    => 'foos'
)->make;

DESCRIPTION

WARNING!!! This module is still in alpha stage. Use it for test purposes only as interface might change in the future.

The module provides means to create OBEX protocol 0x00 (null-terminated Unicode text) packet headers. Unless you are making a custom header you probably want to use Net::OBEX::Packet::Headers instead.

CONSTRUCTOR

new

# "Name" header
my $header
= Net::OBEX::Packet::Headers::Unicode->new( name => 'foos' );

# Custom header with HI of 0x09
my $header
= Net::OBEX::Packet::Headers::Unicode->new( "\x09" => 'foos' );

Constructs and returns a Net::OBEX::Packet::Headers::Unicode obect. Two arguments: first is the byte of the HI identifier of the header and second argument is the 1 byte value of the header. Note: instead of the HI identifier byte you may use one of the names of standard OBEX headers. The possible names you can use are as follows:

name

The Name header (name of the object (often a file name))

description

The Description header (text description on an object)

Note: You don't need to end your value with a null byte. The module does this automatically.

METHODS

make

my $raw_header = $header->make;

Takes no arguments, returns a raw data of the header suitable to go down the wire.

my $raw_header = $header->header;

Must be called after a call to make(). Takes no arguments, return value is the return of make(), the only difference is that data has been "made" already.

value

my $old_value = $header->value;

$header->value( $new_value );

Returns the currently set header value (see new() method). If called with an optional argument will set the header value to the value of the argument, and the following calls to make() will produce headers with this new value.

hi

my $old_hi = $header->hi;

$header->hi( "\x01" );

Returns the currently set header HI identifier. If called with an optional argument will set the header HI identifier to the value of the argument, and the following calls to make() will produce headers with this new HI.

AUTHOR

Zoffix Znet, <zoffix at cpan.org> (http://zoffix.com, http://haslayout.net)

BUGS

Please report any bugs or feature requests to bug-net-obex-packet-headers at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-OBEX-Packet-Headers. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Net::OBEX::Packet::Headers::Unicode

You can also look for information at:

COPYRIGHT & LICENSE

Copyright 2008 Zoffix Znet, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.