-- --
-- S p e c --
-- --
--- --
--- Copyright (C) 2000-2001 Ada Core Technologies, Inc. --
+-- Copyright (C) 2000-2005, AdaCore --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
-- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
-- for more details. You should have received a copy of the GNU General --
-- Public License distributed with GNAT; see file COPYING. If not, write --
--- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
--- MA 02111-1307, USA. --
+-- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
+-- Boston, MA 02110-1301, USA. --
-- --
-- As a special exception, if other files instantiate generics from this --
-- unit, or you link this unit with other files to produce an executable, --
-- however invalidate any other reasons why the executable file might be --
-- covered by the GNU Public License. --
-- --
--- GNAT is maintained by Ada Core Technologies Inc (http://www.gnat.com). --
+-- GNAT was originally developed by the GNAT team at New York University. --
+-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
------------------------------------------------------------------------------
-- The complete CGI Cookie specification can be found in the RFC2109 at:
-- http://www.ics.uci.edu/pub/ietf/http/rfc2109.txt
--- This package builds up data tables whose memory is not released.
--- A CGI program is expected to be a short lived program and so it
--- is adequate to have the underlying OS free the program on exit.
+-- This package builds up data tables whose memory is not released. A CGI
+-- program is expected to be a short lived program and so it is adequate to
+-- have the underlying OS free the program on exit.
package GNAT.CGI.Cookie is
-- will be raised when calling any services below (except for Ok).
Cookie_Not_Found : exception;
- -- This exception is raised when a specific parameter is not found.
+ -- This exception is raised when a specific parameter is not found
procedure Put_Header
(Header : String := Default_Header;
-- max_age=<max_age>; path=<path>[; secured]
function Ok return Boolean;
- -- Returns True if the CGI cookie environment is valid and False
- -- otherwise. Every service used when the CGI environment is not valid
- -- will raise the exception Data_Error.
+ -- Returns True if the CGI cookie environment is valid and False otherwise.
+ -- Every service used when the CGI environment is not valid will raise the
+ -- exception Data_Error.
function Count return Natural;
- -- Returns the number of cookies received by the CGI.
+ -- Returns the number of cookies received by the CGI
function Value
(Key : String;
- Required : Boolean := False)
- return String;
- -- Returns the cookie value associated with the cookie named Key. If
- -- cookie does not exist, returns an empty string if Required is
- -- False and raises the exception Cookie_Not_Found otherwise.
+ Required : Boolean := False) return String;
+ -- Returns the cookie value associated with the cookie named Key. If cookie
+ -- does not exist, returns an empty string if Required is False and raises
+ -- the exception Cookie_Not_Found otherwise.
function Value (Position : Positive) return String;
- -- Returns the value associated with the cookie number Position
- -- of the CGI. It raises Cookie_Not_Found if there is no such
- -- cookie (i.e. Position > Count)
+ -- Returns the value associated with the cookie number Position of the CGI.
+ -- It raises Cookie_Not_Found if there is no such cookie (i.e. Position >
+ -- Count)
function Exists (Key : String) return Boolean;
- -- Returns True if the cookie named Key exist and False otherwise.
+ -- Returns True if the cookie named Key exist and False otherwise
function Key (Position : Positive) return String;
- -- Returns the key associated with the cookie number Position of
- -- the CGI. It raises Cookie_Not_Found if there is no such cookie
- -- (i.e. Position > Count)
+ -- Returns the key associated with the cookie number Position of the CGI.
+ -- It raises Cookie_Not_Found if there is no such cookie (i.e. Position >
+ -- Count)
procedure Set
(Key : String;
Max_Age : Natural := Natural'Last;
Path : String := "/";
Secure : Boolean := False);
- -- Add a cookie to the list of cookies. This will be sent back
- -- to the server by the Put_Header service above.
+ -- Add a cookie to the list of cookies. This will be sent back to the
+ -- server by the Put_Header service above.
generic
with procedure
OSDN Git Service
