Nicholas J Humfrey > Net-LibLO-0.06 > Net::LibLO::Message

Download:
Net-LibLO-0.06.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Source  

NAME ^

Net::LibLO::Message

SYNOPSIS ^

  use Net::LibLO::Message;

  my $msg = new Net::LibLO::Message( );
  $msg->add_string( "Hello World!" );
  $msg->add_int32( 41287 );

DESCRIPTION ^

Net::LibLO::Message is a perl class which represents a single OSC message.

new( )

Create a new, empty message.

new( types, ... )

types The types of the data items in the message.

i 32 bit signed integer.
f 32 bit IEEE-754 float.
s A string
d 64 bit IEEE-754 double.
S A symbol - used in systems which distinguish strings and symbols.
c A single 8bit charater
T Symbol representing the value True.
F Symbol representing the value False.
N Symbol representing the value Nil.
I Symbol representing the value Infinitum.

... The data values to be transmitted. The types of the arguments passed here must agree with the types specified in the type parameter.

add_int32( int )

Adds a 32-bit integer to the message.

add_float( float )

Adds a 32-bit floating point number to the message.

add_string( string )

Adds a string to the message

add_double( double )

Adds a 64 bit floating point number to the message.

add_symbol( symbol )

Adds a symbol string to the message. Used in systems which distinguish strings and symbols.

add_char( char )

Adds a single 8-bit character to the message.

add_true()

Adds a symbol representing the value True to the message.

add_false()

Adds a symbol representing the value False to the message.

add_nil()

Adds a symbol representing the value Nil to the message.

add_infinitum()

Adds a symbol representing the value Infinitum to the message.

length( path )

Returns the length of the message in bytes - the path the message is going to be sent to is also required.

pretty_print()

Prints the message to STDOUT - probably most useful for debugging.

AUTHOR ^

Nicholas J. Humfrey, njh@aelius.com

COPYRIGHT AND LICENSE ^

Copyright (C) 2005 Nicholas J. Humfrey

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 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 General Public License for more details.

syntax highlighting: