NAME

WWW::Livesite::Headers - HTTP Header Hash

SYNOPSIS

  use WWW::Livesite::Headers;
  my $h = WWW::Livesite::Headers->new();
  $h->parse($header_str);
  $$h{'Pragma'} = 'no-cache';
  print $h->to_string, "\n";
  for ($h->as_array) {
    printf "%s: %s\n", @$_;
  }

EXPORTS

Nothing exported by default

DEPENDENCIES

This module requires these other modules and libraries:

    Perl::Module
    Data::OrderedHash
    Tie::Hash

DESCRIPTION

  #!/usr/bin/perl
  use strict;
  use warnings FATAL => qw(all);
  use WWW::Livesite::Headers;
    
  my $str = <<__end;
  Pragma: no-cache
  Server: lws
  Date: now
  Content-Type: text/plain
  __end
    
  # Create a new headers object
  my $h = WWW::Livesite::Headers->new();
    
  # Parse the above headers (this could also have been done by
  # passing $str to the constructor).
  $h->parse($str);
    
  # Set a new header
  $$h{'Cache-control'} = 'no-cache, no-store, max-age=0';
    
  # Set the special content-type header (will always output last)
  $$h{'content-Type'} = 'text/html';
    
  # Setting a value for one which exists forks it into an array,
  # meaning there are two header fields.
  $$h{'Pragma'} = 'repeat';
    
  # Set a value unless it already exists
  $$h{'Server'} ||= 'MyServer';
    
  # Override a value (avoid the forking behavior by assigning an
  # array).  If the array were to have two items, it would result
  # in two header fields.
  $$h{'Date'} = ['12/30/73'];
    
  # Set another header (and notice that it is upper-cased on output).
  $$h{'expires'} = '0';
    
  # Output the string.  Notice that the fields are printed in FIFO order as
  # to when their key was added to the hash, with the exception of 
  # 'Content-Type', which is always last (and gets an extra newline).
  print $h->to_string, "\n";
    
  # The as_array method provides an entry for each header.  The entry is
  # an array reference with to items, the name and its definition.
  for ($h->as_array) {
    my ($k, $v) = @$_;
    print "<$k>$v</$k>\n";
  }

Sample output of the above

  Pragma: no-cache
  Pragma: repeat
  Server: lws
  Date: 12/30/73
  Cache-Control: no-cache, no-store, max-age=0
  Expires: 0
  Content-Type: text/html
    
  <Pragma>no-cache</Pragma>
  <Pragma>repeat</Pragma>
  <Server>lws</Server>
  <Date>12/30/73</Date>
  <Cache-Control>no-cache, no-store, max-age=0</Cache-Control>
  <Expires>0</Expires>
  <Content-Type>text/html</Content-Type>

PACKAGE INTERNALS

TODO

Wrap (subclass) HTTP::Headers

The assignment operator

AUTHORS

    Ryan Gies <ryangies@cpan.org>

COPYRIGHT

    Copyright (C) 2014-2016 by Ryan Gies. All rights reserved.
    Copyright (C) 2006-2013 by Livesite Networks, LLC. All rights reserved.
    Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.
    Redistribution and use in source and binary forms, with or without 
    modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright notice, 
    this list of conditions and the following disclaimer.
    * The origin of this software must not be misrepresented; you must not 
    claim that you wrote the original software. If you use this software in a 
    product, an acknowledgment in the product documentation would be 
    appreciated but is not required.
    * Altered source versions must be plainly marked as such, and must not be 
    misrepresented as being the original software.
    * The name of the author may not be used to endorse or promote products 
    derived from this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED 
    WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
    EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
    OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
    IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
    OF SUCH DAMAGE.
    To the best of our knowledge, no patented algorithms have been used. However, we
    do not have the resources to carry out a patent search, and therefore cannot 
    give any guarantee of the above statement.