Class: SONIC_STREAM_www

Source Location: /streams/sonic.stream.www.php

Class Overview [line 22]

SONIC_thread
   |
   --SONIC_stream
      |
      --SONIC_STREAM_www

Author(s):

Version:

Copyright:

Variables

Constants

Methods


Inherited Methods

Class: SONIC_thread

SONIC_thread::sonic_thread_run()
fork entire program Memory and Execution space aka M.E.


Class Details

[ Top ]


Class Variables

$cycle =  false

[line 88]

run once or cycle

enable or disable the internal mini loop daemon

Type: boolean

Overrides:

[ Top ]

$http_buffer =  ''

[line 66]

HTTP buffer

Type: string

Overrides:

[ Top ]

$http_buffer_idle =  true

[line 72]

HTTP buffer already initiated or still untouched

Type: boolean

Overrides:

[ Top ]

$http_header_array = array()

[line 60]

HTTP header tag key value pair array

Tags:

  • see - sonic.inc::sonic_header2array() usually an array of this type

Type: array

Overrides:

[ Top ]

$http_response_code =  200

[line 53]

HTTP response code

eg. 200, 404

Type: integer

Overrides:

[ Top ]

$rotate_mode =  true

[line 97]

rotate mode flag switch

default mode behaviour is threaded

Type: boolean

Overrides:

[ Top ]

$sock_out =  NULL

[line 79]

mux'ed resource socket output var

Type: resource

Overrides:

[ Top ]


Class Methods

header

void header( $hline, [ $replace = true], [ $hrcode = null])

[line 1167]

PHP header() (reserved alias)

Tags:

Parameters:

  • $hline -
  • $replace -
  • $hrcode -

[ Top ]

header_named_line

void header_named_line( $name, [ $value = null], [ $replace = true])

[line 1321]

header_named_line() (reserved alias)

Tags:

Parameters:

  • $name -
  • $value -
  • $replace -

[ Top ]

php_exit

void php_exit( [ $val = null])

[line 1140]

PHP exit() (reserved alias)

Tags:

Parameters:

  • $val -

[ Top ]

php_header

void php_header( $hline, [ $replace = true], [ $hrcode = null])

[line 1179]

PHP header() (reserved alias)

Tags:

Parameters:

  • $hline -
  • $replace -
  • $hrcode -

[ Top ]

php_header_named_line

void php_header_named_line( $name, [ $value = null], [ $replace = true])

[line 1330]

header_named_line() (reserved alias)

Tags:

Parameters:

  • $name -
  • $value -
  • $replace -

[ Top ]

php_session_start

boolean php_session_start( )

[line 966]

PHP session_start() (reserved alias)

Tags:

Parameters:

[ Top ]

php_setcookie

boolean php_setcookie( $name, [ $value = ''], [ $expire = 0], [ $path = ''], [ $domain = ''], [ $secure = false], [ $httponly = false])

[line 1049]

PHP setcookie() (reserved alias)

Tags:

Parameters:

  • $name -
  • $value -
  • $expire -
  • $path -
  • $domain -
  • $secure -
  • $httponly -

[ Top ]

php_setrawcookie

boolean php_setrawcookie( $name, [ $value = ''], [ $expire = 0], [ $path = ''], [ $domain = ''], [ $secure = false], [ $httponly = false])

[line 1099]

PHP setrawcookie() (reserved alias)

Tags:

Parameters:

  • $name -
  • $value -
  • $expire -
  • $path -
  • $domain -
  • $secure -
  • $httponly -

[ Top ]

php_set_cookie

boolean php_set_cookie( $name, [ $value = ''], [ $parts = array()], [ $encode = 'rawurl'])

[line 1273]

set_cookie() (reserved alias)

Tags:

Parameters:

  • $name -
  • $value -
  • $parts -
  • $encode -

[ Top ]

session_start

boolean session_start( )

[line 959]

PHP session_start() (reserved alias)

Tags:

Parameters:

[ Top ]

setcookie

boolean setcookie( $name, [ $value = ''], [ $expire = 0], [ $path = ''], [ $domain = ''], [ $secure = false], [ $httponly = false])

[line 1039]

PHP setcookie() (reserved alias)

Tags:

Parameters:

  • $name -
  • $value -
  • $expire -
  • $path -
  • $domain -
  • $secure -
  • $httponly -

[ Top ]

setrawcookie

boolean setrawcookie( $name, [ $value = ''], [ $expire = 0], [ $path = ''], [ $domain = ''], [ $secure = false], [ $httponly = false])

[line 1089]

PHP setrawcookie() (reserved alias)

Tags:

Parameters:

  • $name -
  • $value -
  • $expire -
  • $path -
  • $domain -
  • $secure -
  • $httponly -

[ Top ]

set_cookie

boolean set_cookie( $name, [ $value = ''], [ $parts = array()], [ $encode = 'rawurl'])

[line 1263]

set_cookie() (reserved alias)

Tags:

Parameters:

  • $name -
  • $value -
  • $parts -
  • $encode -

[ Top ]

sonic_stream_main

void sonic_stream_main( [resource $sock_in = null])

[line 146]

stream main (wrapper)

this is really a wrapper function for sonic_stream_www_main(), which iterates the same operation in a loop or once depending on internal config switched flag option

Tags:

Parameters:

  • resource $sock_in - third party support (library mode) override, resource socket bound and listening for connections

[ Top ]

sonic_stream_www_main

void sonic_stream_www_main( [resource $sock_in = null])

[line 184]

stream main

Tags:

  • see - SONIC_stream::sonic_stream_main()

Parameters:

  • resource $sock_in - third party support (library mode) override, resource socket bound and listening for connections

[ Top ]

sonic_stream_www_ob

mixed sonic_stream_www_ob( [ $ob_func = null])

[line 1654]

ob wrapper

Tags:

Parameters:

  • $ob_func -

[ Top ]

sonic_stream_www_prelog

string sonic_stream_www_prelog( )

[line 1598]

log output unifier

returns a uniform prefix for log/output entries

Tags:

Parameters:

[ Top ]

sonic_stream_www_start

array sonic_stream_www_start( [resource $sock_in = NULL])

[line 1378]

main setup

load signal handers and reset internal variables incase of cycle. poll socket_accept listening socket for connected client then return

Tags:

Parameters:

  • resource $sock_in - third party support (library mode) override, listening resource socket

[ Top ]

sonic_stream_www_stop

void sonic_stream_www_stop( [string $msg_close = null])

[line 1611]

main shutdown/finish

closes in and out resource socket variables and echos trace

Tags:

Parameters:

  • string $msg_close - default close exit message override

[ Top ]

sonic_www_echo

void sonic_www_echo( integer $http_response_code, string $out, [resource $sock = null])

[line 1756]

HTTP response

form and write out HTTP response on internal resource socket or supplied override. given data in $out will be merged with internal http buffer

Tags:

Parameters:

  • integer $http_response_code - HTTP response code
  • string $out - HTTP body data
  • resource $sock - third party support (library mode) override, output resource socket to write response to

[ Top ]

sonic_www_exit

void sonic_www_exit( [integer $http_response_code = null], [mixed $out = 0], [resource $sock = null])

[line 1694]

HTTP response with exit

wrapper for sonic_www_echo() with exit()

Tags:

Parameters:

  • integer $http_response_code - HTTP response code
  • mixed $out - HTTP body data
  • resource $sock - third party support (library mode) override, output resource socket to write response to

[ Top ]

sonic_www_exit_string

string sonic_www_exit_string( )

[line 1678]

error string

Tags:

Parameters:

[ Top ]

sonic_www_mimetype

string sonic_www_mimetype( $file, [ $mimetype_file = SONIC_MIME_FILE])

[line 1834]

mime type

fetch mime type using mime type definition file

Tags:

  • return - string on success or false on failure

Parameters:

  • $file -
  • $mimetype_file -

[ Top ]

sonic_www_php_exit

void sonic_www_php_exit( [ $val = null])

[line 1150]

PHP exit()

Tags:

Parameters:

  • $val -

[ Top ]

sonic_www_php_header

void sonic_www_php_header( $hline, [ $replace = true], [ $hrcode = null])

[line 1192]

PHP header()

Tags:

Parameters:

  • $hline -
  • $replace -
  • $hrcode -

[ Top ]

sonic_www_php_header_named_line

void sonic_www_php_header_named_line( string $name, [string $value = null], [boolean $replace = true])

[line 1341]

header_named_line()

Parameters:

  • string $name -
  • string $value -
  • boolean $replace -

[ Top ]

sonic_www_php_session_start

boolean sonic_www_php_session_start( )

[line 973]

PHP session_start()

Tags:

Parameters:

[ Top ]

sonic_www_php_setcookie

boolean sonic_www_php_setcookie( $cookie_name, [ $cookie_value = ''], [ $expire = 0], [ $path = ''], [ $domain = ''], [ $secure = false], [ $httponly = false])

[line 1059]

PHP setcookie()

Tags:

Parameters:

  • $cookie_name -
  • $cookie_value -
  • $expire -
  • $path -
  • $domain -
  • $secure -
  • $httponly -

[ Top ]

sonic_www_php_setrawcookie

boolean sonic_www_php_setrawcookie( $cookie_name, [ $cookie_value = ''], [ $expire = 0], [ $path = ''], [ $domain = ''], [ $secure = false], [ $httponly = false])

[line 1110]

PHP setrawcookie()

Tags:

Parameters:

  • $cookie_name -
  • $cookie_value -
  • $expire -
  • $path -
  • $domain -
  • $secure -
  • $httponly -

[ Top ]

sonic_www_php_set_cookie

boolean sonic_www_php_set_cookie( string $name, [string $value = ''], [array $parts = array()], [string $encode = 'rawurl'])

[line 1286]

set_cookie()

Parameters:

  • string $name -
  • string $value -
  • array $parts -
  • string $encode -

[ Top ]

_sonic_stream_www_handler

void _sonic_stream_www_handler( [integer $sig = NULL])

[line 104]

signal termination handler

Parameters:

  • integer $sig - posix process signal

[ Top ]


Class Constants


Documentation generated on Fri, 12 Sep 2008 19:19:05 +1000 by phpDocumentor 1.4.1