GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  XML::COMPILE::XOP::INCLUDE (3)

.ds Aq ’

NAME

XML::Compile::XOP::Include - Represents one XOP node.

CONTENTS

SYNOPSIS



  # See also SYNOPSIS of XML::Compile::XOP
  my $xop       = XML::Compile::XOP->new;
  my $xop_image = $xop->bytes($binary_image);
  my $answer    = $call->(image => $xop_image);



DESCRIPTION

Represents one data-set which will be represented as separate (binary) object during transport. This can only be used on data fields which are base64Binary.

YOU SHOULD NOT instantiate this kind of objects directly, but use the XML::Compile::XOP method to create them.

The object is overloaded to produce the contained data when a scalar is required, for instance when you call functions like length. This means that, hopefully, the end-user does not see much of a difference between data which is transported inline or packaged separately.

METHODS

    Constructors

XML::Compile::XOP::Include-><B>fromMimeB>($object) Collect the data from a HTTP::Message object.
XML::Compile::XOP::Include-><B>newB>(%options) You have to specify either a file or byte source. Otherwise, the constructor will return undef.



 -Option--Default
  bytes   undef
  cid     <required>
  file    undef
  type    <required>
  xmime   <required>
  xop     <required>



bytes => STRING|SCALAR Take the data from a STRING of reference.
cid => STRING The Content-ID of the binary attachment.
file => FILENAME|FILEHANDLE Take the data from the specified file.
type => MIMETYPE The MIME-Type of the data.
xmime => VERSION
xop => VERSION

    Accessors

$obj-><B>cidB>() Returns the Content-ID.
$obj-><B>contentB>( [$byref] ) Returns the content, when $byref (boolean) is true, then the value is returned by reference.

    Processing

$obj-><B>mimePartB>( [$headers] ) Produce the message part which contains a normal mime representation of a binary file. You may provide an initial $headers (HTTP::Headers) object, or an ARRAY of headers to instantiate such an object.
$obj-><B>writeB>($filename|$fh) Write the content to the specified FILE.
$obj-><B>xmlNodeB>($document, $path, $tag) The $document will be used to construct the node from. The $path is an indicator for the location of the node within the data structure (used in error messages). The $tag is the prefixed name for the node to be created.

Returned is an XML node to be included in the output tree.

OVERLOAD

overload: <B>‘‘’’B> This object stringifies to its binary content.

SEE ALSO

This module is part of XML-Compile-SOAP distribution version 3.18, built on March 22, 2016. Website: http://perl.overmeer.net/xml-compile/

Please post questions or ideas to the mailinglist at http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/xml-compile . For live contact with other developers, visit the #xml-compile channel on irc.perl.org.

LICENSE

Copyrights 2007-2016 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 XML::COMPILE::XOP::INCLUDE (3) 2016-03-22

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.