Response.php

Show:

inherited

Classes
- \PEAR2\Net\RouterOS\Response

Table of Contents

RouterOS API client implementation.

RouterOS is the flag product of the company MikroTik and is a powerful router software. One of its many abilities is to allow control over it via an API. This package provides a client for that API, in turn allowing you to use PHP to control RouterOS hosts. PHP version 5

Author: Vasil Rangelov
Category: Net
Copyright: 2011 Vasil Rangelov
License: LGPL License 2.1
Link: http://pear2.php.net/PEAR2_Net_RouterOS
Package: PEAR2_Net_RouterOS
Version: 1.0.0b4

\PEAR2\Net\RouterOS\Response
jump to top

Package: PEAR2_Net_RouterOS

Represents a RouterOS response.

Parent(s): \PEAR2\Net\RouterOS\Message
Author: Vasil Rangelov
Category: Net
License: LGPL License 2.1
Link: http://pear2.php.net/PEAR2_Net_RouterOS

Constants

 
                TYPE_FINAL
                = '!done'

The last response for a request.

 
                TYPE_DATA
                = '!re'

A response with data.

 
                TYPE_ERROR
                = '!trap'

A response signifying error.

 
                TYPE_FATAL
                = '!fatal'

A response signifying a fatal error, due to which the connection would be terminated.

Properties

string $_type

The response type.

Details

Type: string

array $unrecognizedWords = array()

An array of unrecognized words in network order.

Default valuearray()Details

Type: array

Methods

__construct(\PEAR2\Net\RouterOS\Communicator $com, bool $asStream = false, int $timeout_s = 0, int $timeout_us = null, \PEAR2\Net\RouterOS\Registry $reg = null) : void

Extracts a new response from a communicator.

Parameters

Name	Type	Description
$com	\PEAR2\Net\RouterOS\Communicator	The communicator from which to extract the new response.
$asStream	bool	Whether to populate the argument values with streams instead of strings.
$timeout_s	int	If a response is not immediatly available, wait this many seconds. If NULL, wait indefinetly.
$timeout_us	int	Microseconds to add to the waiting time.
$reg	\PEAR2\Net\RouterOS\Registry	An optional registry to sync the response with.

Details

See
See

_receive(\PEAR2\Net\RouterOS\Communicator $com, bool $asStream = false, int $timeout_s = 0, int $timeout_us = null) : void

Extracts a new response from a communicator.

This is the function that performs the actual receiving, while the constructor is also involved in locks and registry sync.

Parameters

Name	Type	Description
$com	\PEAR2\Net\RouterOS\Communicator	The communicator from which to extract the new response.
$asStream	bool	Whether to populate the argument values with streams instead of strings.
$timeout_s	int	If a response is not immediatly available, wait this many seconds. If NULL, wait indefinetly.
$timeout_us	int	Microseconds to add to the waiting time.

getType() : string

Gets the response type.

Returns

Type	Description
string	The response type.

Details

See

getUnrecognizedWords() : array

Gets a list of unrecognized words.

Returns

Type	Description
array	The list of unrecognized words.

setType(string $type) : \PEAR2\Net\RouterOS\Response | \PEAR2\Net\RouterOS\Response

Sets the response type.

Sets the response type. Valid values are the TYPE_* constants.

Parameters

Name	Type	Description
$type	string	The new response type.

Returns

Type	Description
\PEAR2\Net\RouterOS\Response \| \PEAR2\Net\RouterOS\Response	The response object.

Details

Fluent: This method is part of a fluent interface and will return the same instance
See

Response.php

\PEAR2\Net\RouterOS\Responsejump to top

Constants

Properties

Methods

\PEAR2\Net\RouterOS\Response
jump to top