CakeSocket Class Info:
- Class Declaration:
class CakeSocket extends Object
- File name:
- cake/libs/cake_socket.php
- Description:
Cake network socket connection class.
Core base class for network communication.
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs
Properties:
-
_baseConfig array
Base configuration settings for the socket connection
-
config array
Configuration settings for the socket connection
-
connected boolean
This boolean contains the current state of the CakeSocket class
-
connection resource
Reference to socket connection resource
-
description string
Object description
-
lastError array
This variable contains an array with the last error number (num) and string (str)
Method Summary:
- abort( )
- address( )
- addresses( )
- cakeError( $method, $messages = array ( ) )
- connect( )
- __construct( $config = array ( ) )
- __destruct( )
- disconnect( )
- dispatchMethod( $method, $params = array ( ) )
- host( )
- lastError( )
- log( $msg, $type = 2 )
- Object( )
- __openPersistent( $name, $type = NULL )
- _persist( $name, $return, $object, $type = NULL )
- read( $length = 1024 )
- requestAction( $url, $extra = array ( ) )
- reset( $state = NULL )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- setLastError( $errNum, $errStr )
- _stop( $status = 0 )
- toString( )
- write( $data )
abort
topAbort socket operation.
- Method defined in:
- cake/libs/cake_socket.php on line 253
- Return
boolean Success
- Access
public
address
topGet the IP address of the current connection.
- Method defined in:
- cake/libs/cake_socket.php on line 155
- Return
string IP address
- Access
public
addresses
topGet all IP addresses associated with the current connection.
- Method defined in:
- cake/libs/cake_socket.php on line 169
- Return
array IP addresses
- Access
public
cakeError
topUsed to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
- Parameters:
-
-
string $method required
Method to be called in the error class (AppError or ErrorHandler classes)
-
array $messages optional array ( )
Message that is to be displayed by the error class
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
connect
topConnect the socket to the given host and port.
- Method defined in:
- cake/libs/cake_socket.php on line 107
- Return
boolean Success
- Access
public
__construct
topConstructor.
- Parameters:
-
-
array $config optional array ( )
Socket configuration, which will be merged with the base configuration
-
- Method defined in:
- cake/libs/cake_socket.php on line 92
__destruct
topDestructor, used to disconnect from current connection.
- Method defined in:
- cake/libs/cake_socket.php on line 280
- Access
private
disconnect
topDisconnect the socket from the current connection.
- Method defined in:
- cake/libs/cake_socket.php on line 262
- Return
boolean Success
- Access
public
dispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- cake/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
host
topGet the host name of the current connection.
- Method defined in:
- cake/libs/cake_socket.php on line 141
- Return
string Host name
- Access
public
lastError
topGet the last error as a string.
- Method defined in:
- cake/libs/cake_socket.php on line 183
- Return
string Last error
- Access
public
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
Object
topA hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
__openPersistent
topOpen the persistent class file for reading Used by Object::_persist()
- Parameters:
-
-
string $name required
Name of persisted class
-
string $type optional NULL
Type of persistance (e.g: registry)
-
- Method defined in:
- cake/libs/object.php on line 268
- Return
void
- Access
private
_persist
topChecks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
read
topRead data from the socket. Returns false if no data is available or no connection could be established.
- Parameters:
-
-
integer $length optional 1024
Optional buffer length to read; defaults to 1024
-
- Method defined in:
- cake/libs/cake_socket.php on line 227
- Return
mixed Socket data
- Access
public
requestAction
topCalls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
- Parameters:
-
-
mixed $url required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
reset
topResets the state of this Socket instance to it's initial state (before Object::__construct got executed)
- Parameters:
-
-
$state optional NULL
-
- Method defined in:
- cake/libs/cake_socket.php on line 290
- Return
boolean True on success
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
- Parameters:
-
-
array $properties optional array ( )
An associative array containing properties and corresponding values.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
setLastError
topSet the last error.
- Parameters:
-
-
integer $errNum required
Error code
-
string $errStr required
Error string
-
- Method defined in:
- cake/libs/cake_socket.php on line 198
- Access
public
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
write
topWrite data to the socket.
- Parameters:
-
-
string $data required
The data to write to the socket
-
- Method defined in:
- cake/libs/cake_socket.php on line 209
- Return
boolean Success
- Access
public
