XML::Stream::Namespace (3)

Leading comments

Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/XML::Stream::Namespace.3pm".)

NAME

XML::Stream::Namespace - Object to make defining Namespaces easier in
                         XML::Stream.

SYNOPSIS

XML::Stream::Namespace is a helper package to XML::Stream. It provides a clean way of defining Namespaces for XML::Stream to use when connecting.

DESCRIPTION

  This module allows you to set and read elements from an XML::Stream
  Namespace.

METHODS

  SetNamespace("mynamespace");
  SetXMLNS("www.mynamespace.com/xmlns");
  SetAttributes(attrib1=>"value1",
                attrib2=>"value2");

  GetNamespace() returns "mynamespace"
  GetXMLNS() returns "www.mynamespace.com/xmlns"
  GetAttributes() returns a hash ( attrib1=>"value1",attrib2=>"value2")
  GetStream() returns the following string:
    "xmlns:mynamespace='www.nynamespace.com/xmlns 
     mynamespace:attrib1='value1' 
     mynamespace:attrib2='value2'"

EXAMPLES

  $myNamespace = XML::Stream::Namespace->new("mynamspace");
  $myNamespace->SetXMLNS("www.mynamespace.org/xmlns");
  $myNamespace->SetAttributes(foo=>"bar",
                              bob=>"vila");

  $stream = XML::Stream->new;
  $stream->Connect(name=>"foo.bar.org",
                   port=>1234,
                   namespace=>"foo:bar",
                   namespaces=>[ $myNamespace ]);

  #
  # The above Connect will send the following as the opening string
  # of the stream to foo.bar.org:1234...
  #
  #   <stream:stream 
  #    xmlns:stream="etherx.jabber.org/streams"
  #    to="foo.bar.org"
  #    xmlns="foo:bar" 
  #    xmlns:mynamespace="www.mynamespace.org/xmlns"
  #    mynamespace:foo="bar"
  #    mynamespace:bob="vila">
  #

AUTHOR

Written by Ryan Eatmon in February 2000 Idea By Thomas Charron in January of 2000 for etherx.jabber.org/streams

Currently maintained by Darian Anthony Patrick.

COPYRIGHT

Copyright (C) 1998-2004 Jabber Software Foundation jabber.org

This module licensed under the

version 2.1.