API Documentation

Zend/TimeSync/Protocol.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_TimeSync  
Version
$Id: Protocol.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_TimeSync_Protocol

Package: Zend\TimeSync

Abstract class definition for all timeserver protocols

Children
\Zend_TimeSync_Sntp
\Zend_TimeSync_Ntp
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_exceptions= ''

Exceptions that might have occured

Details
Type
array
Propertyprotectedarray  $_info= 'array()'

Holds information passed/returned from timeserver

Default valuearray()Details
Type
array
Propertyprotectedarray  $_socket= ''

Holds the current socket connection

Details
Type
array
Propertyprotectedstring  $_timeserver= ''

Hostname for timeserver

Details
Type
string

Methods

methodprotected_connect( ) : void

Connect to the specified timeserver.

Throws
Exception Description
\Zend_TimeSync_Exception When the connection failed
methodprotected_disconnect( ) : void

Disconnects from the peer, closes the socket.

methodprotected_extract( string|array $data ) : integer
abstract

Abstract method that extracts the binary data returned from the timeserver

Parameters
Name Type Description
$data string|array

Data returned from the timeserver

Returns
Type Description
integer
methodprotected_prepare( ) : mixed
abstract

Abstract method that prepares the data to send to the timeserver

Returns
Type Description
mixed
methodprotected_read( ) : mixed
abstract

Abstract method that reads the data returned from the timeserver

Returns
Type Description
mixed
methodprotected_write( string $data ) : void
abstract

Abstract method that writes data to to the timeserver

Parameters
Name Type Description
$data string

Data to write

methodpublicgetDate( string|\Zend_Locale $locale = null ) : \Zend_Date

Query this timeserver without using the fallback mechanism

Parameters
Name Type Description
$locale string|\Zend_Locale

(Optional) Locale

Returns
Type Description
\Zend_Date
methodpublicgetInfo( ) : array

Return information sent/returned from the timeserver

Returns
Type Description
array
Documentation was generated by DocBlox 0.15.1.