From 7578cb9adb72b8761731a819b0c92327ae99cd62 Mon Sep 17 00:00:00 2001 From: Gibheer Date: Tue, 27 Nov 2012 06:41:09 +0100 Subject: Revert "added the first set of documentation" This reverts commit 37a4a28deec224f7cd9a5a124e22258e868913e4. --- doc/Zero/Request/Server.html | 687 ------------------------------------------- 1 file changed, 687 deletions(-) delete mode 100644 doc/Zero/Request/Server.html (limited to 'doc/Zero/Request/Server.html') diff --git a/doc/Zero/Request/Server.html b/doc/Zero/Request/Server.html deleted file mode 100644 index 2a187d8..0000000 --- a/doc/Zero/Request/Server.html +++ /dev/null @@ -1,687 +0,0 @@ - - - - - - Class: Zero::Request::Server - - — Documentation by YARD 0.8.3 - - - - - - - - - - - - - - - - - - - - - -

Class: Zero::Request::Server - - - -

- -
- -
Inherits:
-
- Object - -
    -
  • Object
    • - - - -
- show all - -
- - - - - - - - - -
Defined in:
-
lib/zero/request/server.rb
- -
-
- -

Overview

-
- -

This class represents all server related information of a request.

- - -
-
-
- - -
-

Constant Summary

- -
- -
KEY_SERVER_NAME = -
-
-

- This constant is part of a private API. - You should avoid using this constant if possible, as it may be removed or be changed in the future. -

- -

the key for the server name

- - -
-
-
- - -
-
- 
'SERVER_NAME'
-
- -
KEY_SERVER_PORT = -
-
-

- This constant is part of a private API. - You should avoid using this constant if possible, as it may be removed or be changed in the future. -

- -

the key for the server port

- - -
-
-
- - -
-
- 
'SERVER_PORT'
-
- -
KEY_SERVER_PROTOCOL = -
-
-

- This constant is part of a private API. - You should avoid using this constant if possible, as it may be removed or be changed in the future. -

- -

the key for the server protocol

- - -
-
-
- - -
-
- 
'SERVER_PROTOCOL'
-
- -
KEY_SERVER_SOFTWARE = -
-
-

- This constant is part of a private API. - You should avoid using this constant if possible, as it may be removed or be changed in the future. -

- -

the key for the server software

- - -
-
-
- - -
-
- 
'SERVER_SOFTWARE'
-
- -
- - - - - -

Instance Attribute Summary (collapse)

- - - - - - -

- Instance Method Summary - (collapse) -

- - - - -
-

Constructor Details

- -
-

- - - (Server) initialize(environment) - - - - - -

-
- -

This creates a new server instance extracting all server related

- -
information from the environment.
- - -
-
-
- - -
- - - - -
- 
-
-
-20
-21
-22
-23
-24
-25
- 		- 
# File 'lib/zero/request/server.rb', line 20
-
-def initialize(environment)
-  @hostname = environment[KEY_SERVER_NAME]
-  @port     = environment[KEY_SERVER_PORT].to_i
-  @protocol = environment[KEY_SERVER_PROTOCOL]
-  @software = environment[KEY_SERVER_SOFTWARE]
-end
-
-
-
- -
- -
-

Instance Attribute Details

- - - -
-

- - - (String) hostname (readonly) - - - - - -

-
- -

get the hostname of the server

- - -
-
-
- -

Returns:

-
    - -
  • - - - (String) - - - - — -
    -

    the hostname

    -
    - -
    • - -
- -
- - - - -
- 
-
-
-32
-33
-34
- 		- 
# File 'lib/zero/request/server.rb', line 32
-
-def hostname
-  @hostname
-end
-
-
-
- - - -
-

- - - (Numeric) port (readonly) - - - - - -

-
- -

get the port

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Numeric) - - - - — -
    -

    the port

    -
    - -
    • - -
- -
- - - - -
- 
-
-
-29
-30
-31
- 		- 
# File 'lib/zero/request/server.rb', line 29
-
-def port
-  @port
-end
-
-
-
- - - -
-

- - - (String) protocol (readonly) - - - - - -

-
- -

get the protocol of the server (normally it should be HTTP/1.1)

- - -
-
-
- -

Returns:

-
    - -
  • - - - (String) - - - - — -
    -

    the protocol

    -
    - -
    • - -
- -
- - - - -
- 
-
-
-35
-36
-37
- 		- 
# File 'lib/zero/request/server.rb', line 35
-
-def protocol
-  @protocol
-end
-
-
-
- - - -
-

- - - (String) software (readonly) - - - - - -

-
- -

get the server software

- - -
-
-
- -

Returns:

-
    - -
  • - - - (String) - - - - — -
    -

    the server software name

    -
    - -
    • - -
- -
- - - - -
- 
-
-
-38
-39
-40
- 		- 
# File 'lib/zero/request/server.rb', line 38
-
-def software
-  @software
-end
-
-
-
- -
- - -
- - - - - \ No newline at end of file -- cgit v1.2.3-70-g09d2