Documentation

Client extends Socket
in package

Implementierung eines Standard-Clients.

Um eine Verbindung mit einem Unix-Socket zu öffnen, kann man den Host und Port auf null setzen und einen optionalen Pfad angeben.

new Client(null, null, null, 'unix', '/full/path/to/my/socket.sock');
Tags
category

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine
link
http://www.ietf.org/rfc/rfc2821.txt
since
20110904

Table of Contents

Constants

APIVERSION  = 1
Version der API-Version der Klasse.
BLOCKING  = 1
Verhalten der Zugriff ist blockierend (es wird auf Daten gewartet)
IDENTIFICATION  = 'Alvine'
Identifizierung der Alvine API
NONBLOCKING  = 0
Verhalten der Zugriff ist nicht blockierend (es wird auf Daten gewartet)
SERIALVERSION  = 1
Version der Klasse (wird für die Serialisierung verwendet. Ändert sich der interne Aufbau der Klasse, so muss dieser Wert nach oben gesetzt werden. Die Serialisierung muss diesen Wert abfragen und bei Bedarf einen Wrapper für das Arbeiten mit veralteten Objekten implmenetieren.
VERSION  = 2
Generelle Alvine-Version
FWRITEERROR_STRATEGY_BREAKQUEUEANDFORWARD  = 3
Die Queue abbrechen, aber im Ablauf fortfahren keine Exception werfen.
FWRITEERROR_STRATEGY_DONOTHING  = 1
Fehler ignorieren.
FWRITEERROR_STRATEGY_EXCEPTION  = 2
Abbrechen und Exception werfen

Properties

$availableTransports  : array
Unterstütze Protokolle
$blockSize  : int
$connectionMode  : int
$context  : Context
$flags  : int
$hasAssociatedProperties  : boolean
$hash  : string
Eindeutige ID
$hasVolatileProperties  : boolean
$host  : string
$log  : string
$logFlag  : boolean
$path  : string
Optionaler Pfad um z.B. mehrere Verbindungen zu einem Host:Port aufmachen zu können tcp://mysql.example.com:3306/root Oder um einen Pfad zu einem UNIX-Socket anzugeben unix:///full/path/to/my/socket.sock
$port  : int
$properties  : array
$protocol  : string
$receiveBuffer  : string
$socket  : resource
$state  : State
$timeout  : int

Methods

__call()  : mixed
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
__clone()  : mixed
Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.
__construct()  : mixed
Neues Client-Objekt erstellen. Es wird noch keine Verbindung aufgebaut.
__destruct()  : mixed
Netzwerkverbindung schliessen
__get()  : mixed
Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.
__isset()  : boolean
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
__serialize()  : array<string|int, mixed>
Serialization of the object and data. In the serialized object also stores meta-information for matching.
__set()  : void
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
__toString()  : string
Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
__unserialize()  : void
__unset()  : mixed
Zurücksetzen von Werten
attachObserver()  : Socket
Fügt einen Beobachter zum Status-Objekt hinzu
connect()  : Socket
Netzwerkverbindung öffnen. Ist bereits eine Verbindung aktiv, so wird diese Verbindung geschlossen und eine neue Verbindung geöffnet.
detachObserver()  : Socket
Diese Methode entfernt einen Beobachter von der Liste der Status-Beobchter.
disableLogging()  : Socket
Logging deaktivieren
dispose()  : Client
Netzwerkverbindung beenden
enableLogging()  : Socket
Logging aktivieren
equals()  : boolean
Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der Wert, der von `Alvine::getID()` zurückgeliefert wird ermittelt und das Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.
getClass()  : string
Name der Klasse
getClone()  : Alvine
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
getClosure()  : Closure
Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.
getHashCode()  : string
Die Methode Alvine::getID() verwenden!
getHost()  : string
Host
getID()  : string
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
getInstanceFromURI()  : static
Erstellen einer Sockeresourche über eine URI
getLog()  : string
Gibt die Logdaten, falls Socket::enableLog() aufgerufen wurde, zurück.
getPath()  : string
Path
getPort()  : integer
Port
getProtocol()  : string
Protokoll
getShortID()  : string
Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.
getStateCode()  : integer
Gibt den aktuellen Status des Objekts zurück
getTimeout()  : integer
Timeout
hasAssociatedProperties()  : boolean
Check if the object has associative properties
hasVolatileProperties()  : boolean
Prüfen ob das Objekt volatile Eigenschaften besitzt
isCallable()  : bool
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
isConnected()  : boolean
Status
isInstanceOf()  : boolean
Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.
propertyExists()  : boolean
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
receive()  : string
Empfang der Daten
send()  : Client
Senden
setConnectionMode()  : Socket
Modus des Sockets
setContext()  : Socket
Setzen des Context der Verbindung
update()  : Client
Ist für diese Klasse ohne Funktion
checkAndAdjustSerialisation()  : array<string|int, mixed>
Dealing with versions
clearReceiveBuffer()  : Socket
Empfangsbuffer leeren
createContext()  : Context
Kontext Objekt
dealWithFwriteError()  : int
Diese Funktion kann von abgeleiteten Klassen überschrieben werden, um zu entscheiden ob man im Falle eines fwrite-Errors abbricht, fortfährt oder eine Exception wirft.
getInternalSocketContents()  : string
Gekapselter Funktionsaufruf für stream_get_contents
getInternalSocketStatus()  : array
Gekapselter Funktionsaufruf für socket_get_status
isReceivedFinished()  : boolean
Prüft, ob die Empfangenen Daten ausreichen und gibt false oder true zurück. Wird true zurückgegeben beendet der Socket das Empfangen der Daten.
processReceiveBuffer()  : Socket
Ermöglicht das überarbeiten der empfangenen Daten, insbesondere bei Clients die ein Long-Polling verwenden.

Constants

APIVERSION

Version der API-Version der Klasse.

public mixed APIVERSION = 1

BLOCKING

Verhalten der Zugriff ist blockierend (es wird auf Daten gewartet)

public mixed BLOCKING = 1

IDENTIFICATION

Identifizierung der Alvine API

public mixed IDENTIFICATION = 'Alvine'

NONBLOCKING

Verhalten der Zugriff ist nicht blockierend (es wird auf Daten gewartet)

public mixed NONBLOCKING = 0

SERIALVERSION

Version der Klasse (wird für die Serialisierung verwendet. Ändert sich der interne Aufbau der Klasse, so muss dieser Wert nach oben gesetzt werden. Die Serialisierung muss diesen Wert abfragen und bei Bedarf einen Wrapper für das Arbeiten mit veralteten Objekten implmenetieren.

public mixed SERIALVERSION = 1

https://php.watch/versions/8.1/serializable-deprecated

VERSION

Generelle Alvine-Version

public mixed VERSION = 2

FWRITEERROR_STRATEGY_BREAKQUEUEANDFORWARD

Die Queue abbrechen, aber im Ablauf fortfahren keine Exception werfen.

protected mixed FWRITEERROR_STRATEGY_BREAKQUEUEANDFORWARD = 3

FWRITEERROR_STRATEGY_DONOTHING

Fehler ignorieren.

protected mixed FWRITEERROR_STRATEGY_DONOTHING = 1

FWRITEERROR_STRATEGY_EXCEPTION

Abbrechen und Exception werfen

protected mixed FWRITEERROR_STRATEGY_EXCEPTION = 2

Properties

$availableTransports

Unterstütze Protokolle

protected static array $availableTransports = null

Protokolle

$blockSize

protected int $blockSize = 8192

Blockgröße beim Lesen aus dem Stream

$connectionMode

protected int $connectionMode = self::BLOCKING

Verbindungsmodus

$flags

protected int $flags = null

intere Flags für die Verbindung

$hash

Eindeutige ID

protected string $hash = null

Die ID wird erst über die Methode \Alvine\Core\Alvine::getID() bei Bedarf ermittelt, deshalb müssen auch abgeleitete Klassen nicht direkt auf den Wert zugreifen, sondern den Wert über getID() holen.

Hash-Wert des Objekts (UUID)

$host

protected string $host = ''

Gegenstelle mit dem eine Verbindung hergestellt werden soll

$log

protected string $log = ''

Zwischenspeicher für den gesamten Kommunikationsverlauf

$logFlag

protected boolean $logFlag = false

Schalter für das Logging

$path

Optionaler Pfad um z.B. mehrere Verbindungen zu einem Host:Port aufmachen zu können tcp://mysql.example.com:3306/root Oder um einen Pfad zu einem UNIX-Socket anzugeben unix:///full/path/to/my/socket.sock

protected string $path = ''

Optionaler Pfad

$properties

protected array $properties = []

Liste mit dynamischen Eigenschaften die über __get und __set bearbeitet werden können.

$protocol

protected string $protocol = ''

Das Verbindungsprotokoll

$receiveBuffer

protected string $receiveBuffer

Im Gegensatz zum Logging, wird dieser Buffer bei jedem Aufruf von receive() geleert.

$socket

protected resource $socket = null

interner Speicher für die Socket-Resource

$timeout

protected int $timeout = 0

Zeit bis zum Abbruch

Methods

__call()

Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.

public __call(string $name, array $arguments) : mixed

Achtung: Wird das Closure in einem Objekt definiert, so ist die Variable $this nicht das Objekt des Closures, sondern des, in dem das Closure definiert wurde. 

// als erster Parameter wird immer das Objekt übergeben
$a->myfunction = function($obj, $b) { echo $b.'!'; };
// Aufruf als Eigenschaft ohne Parameter
$a->myfunction;  // Ausgabe ist ein !
//
// Aufruf als Methode mit Parametern
$a->myfunction('OK');  // Ausgabe ist  OK!
Parameters
$name : string

Funktionsname

$arguments : array

Argumente

Tags
throws
NotCallableException

Exception

Return values
mixed —

Ergebnis des Callbacks

__clone()

Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.

public __clone() : mixed

Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.

__construct()

Neues Client-Objekt erstellen. Es wird noch keine Verbindung aufgebaut.

public __construct(string $host, int $port[, int $timeout = null ][, string $protocol = 'tcp' ][, string $path = null ]) : mixed
Parameters
$host : string

IP oder Hostname, bei IPV6 müssen klammern verwendet werden.

$port : int

Portnummer

$timeout : int = null

Zeit in Sekunden

$protocol : string = 'tcp'

Protokoll (tcp, udp, unix)

$path : string = null

Pfad

__destruct()

Netzwerkverbindung schliessen

public __destruct() : mixed

__get()

Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.

public __get(string $name) : mixed

Vor der Abfrage sollte, damit keine Exception geworfen wird, die Existenz der Eigenschaft geprüft werden.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}
Parameters
$name : string

Name der Eigenschaft

Tags
throws
BadPropertyException
Return values
mixed —

Wert der Eigenschaft

__isset()

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

public __isset(string $name) : boolean
Parameters
$name : string
Return values
boolean

__serialize()

Serialization of the object and data. In the serialized object also stores meta-information for matching.

public __serialize() : array<string|int, mixed>

If a derived class is not to be serializable, then this * method must be overridden and throw an exception. this method must be overridden and throw an exception.

Properties starting with volatile or associated. are handled separately. Properties with prefix volatile are not serialized. For properties with the prefix associated, only the * ID of the object is serialized. ID of the object is serialized. If no object is stored in the property is stored in the property, a TypeException is thrown.

Tags
see
https://php.watch/versions/8.1/serializable-deprecated
Return values
array<string|int, mixed>

__set()

Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.

public __set(string $name, mixed $value) : void

Diese Methode wird indirekt aufgerufen, sobald ein Wert oder eine Funktion einem Objekt zugeordnet wird, die nicht definiert wurde.

class MyObject extends Alvine {
}

$obj = new MyObject();
$obj->myValue = 4;
Parameters
$name : string

Name der Eigenschaft

$value : mixed

Wert der Eigenschaft

Return values
void

__toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

public __toString() : string 
echo (string) new MyObect();
Return values
string —

Daten des Objekts

__unset()

Zurücksetzen von Werten

public __unset(string $name) : mixed
Parameters
$name : string

attachObserver()

Fügt einen Beobachter zum Status-Objekt hinzu

public attachObserver(Observer $observer) : Socket
Parameters
$observer : Observer

Beobachter

Return values
Socket —

Dieses Objekt

detachObserver()

Diese Methode entfernt einen Beobachter von der Liste der Status-Beobchter.

public detachObserver(Observer $observer) : Socket
Parameters
$observer : Observer

Beobachter

Return values
Socket —

Dieses Objekt

dispose()

Netzwerkverbindung beenden

public dispose() : Client

Beendet eine Netzwerkverbindung. Wichtiger Hinweis: Die Funktion schreibt den Verlauf der Kommunikation mit dem Level Trace in den networking-Logger. Dabei ist zu beachten, das eine Weiterleitung der Nachrichten nicht mit Logger-Handlern die dies Klasse verwenden (z.B. MailHandler) funktionieren. Optimalerweise wird ein Dateihandler verwendet.

Tags
see
File
see
Mail
Return values
Client —

Zeiger auf Objekt

equals()

Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der Wert, der von `Alvine::getID()` zurückgeliefert wird ermittelt und das Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.

public equals(Alvine $object) : boolean 
class MyObject extends Alvine };

$objA = new MyObject();
$objB = new MyObject();

if($objA->equals($objB)) {
  // ...
}
Parameters
$object : Alvine

Objekt das überprüft werden soll

Return values
boolean —

true wenn beide Objekte identisch sind.

getClass()

Name der Klasse

public getClass() : string 
class MyObject extends Alvine };
$obj = new MyObject();

echo $obj->getClass();
Tags
see
ClassType::getNormalizedName
Return values
string —

Klassenname

getClone()

Diese Methode gibt ein geklontes Objekt von sich selber zurück.

public getClone([boolean $deepClone = false ]) : Alvine

Wenn eine abgeleitete Klasse diese Methode nicht unterstützt, so muss diese die Methode überschreiben und eine CloneNotSupportedException werfen. Die Standardmethode klont eine seichte Kopie der Eigenschaften. Das bedeutet das Objekte in den Eigenschaften nicht geclont werden. Sollen diese auch geclont werden muss true übergeben werden.

Wenn weitere Funktionen implementiert werden sollen, so muss __clone überschrieben werden

Parameters
$deepClone : boolean = false

Clone aller enthaltenen Objekte

Tags
see
Alvine::__clone()
Return values
Alvine

getClosure()

Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.

public getClosure(string $name) : Closure
Parameters
$name : string

Name des Closure

Tags
throws
NotFoundException
throws
BadPropertyException
Return values
Closure

getHashCode()

Die Methode Alvine::getID() verwenden!

public getHashCode() : string
Tags
deprecated
20140611
Return values
string —

Hashwert des Objektes

getHost()

Host

public getHost() : string
Return values
string —

Host

getID()

Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.

public getID() : string

Objekte haben bei der Erstellung noch keine eindeutige ID, erst mit dem expliziten Aufruf der ID wird diese einmalig erstellt und im Objekt gepseichert.

Diese Methode wird implizit beim Serialisieren aufgerufen.

Die UUID ist dabei vom Type4 (Random)

Return values
string —

UUID des Objektes

getInstanceFromURI()

Erstellen einer Sockeresourche über eine URI

public static getInstanceFromURI(URI $uri[, integer $timeout = null ]) : static 
// Web-Client
new Client('tcp://www.example.com:80/path/to/my/api');

// Unix-Client
new Client('unix:///full/path/to/my/socket.sock');
Parameters
$uri : URI
$timeout : integer = null
Return values
static

getLog()

Gibt die Logdaten, falls Socket::enableLog() aufgerufen wurde, zurück.

public getLog() : string
Return values
string

getPath()

Path

public getPath() : string
Return values
string —

Path

getPort()

Port

public getPort() : integer
Return values
integer —

Port

getProtocol()

Protokoll

public getProtocol() : string
Return values
string —

Protokoll

getShortID()

Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.

public getShortID([int|null $length = null ]) : string

Diese Methode ist hilfreich um Platz zu sparen.

Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision mit anderen Hash vergleichbarer Objekte.

Parameters
$length : int|null = null
Return values
string

getStateCode()

Gibt den aktuellen Status des Objekts zurück

public getStateCode() : integer
Tags
see
SocketState
Return values
integer —

Aktueller Zustand des Objekts

getTimeout()

Timeout

public getTimeout() : integer
Return values
integer —

Timeout

isCallable()

Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).

public isCallable(string $name) : bool 
if($obj->isCallable('myfunction')) {
  $obj->myfunction();
}
Parameters
$name : string

Name der Methode

Return values
bool —

Ergebnis

isConnected()

Status

public isConnected() : boolean

Ist der Socket verbunden?

Return values
boolean —

Verbunden (true/false)

isInstanceOf()

Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.

public isInstanceOf(object $object) : boolean 
if($obj instanceof Alvine &&
   $obj->isInstanceOf($object)) { };

Die Prüfung entspricht

$this instanceof $object
Parameters
$object : object
Return values
boolean

propertyExists()

Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.

public propertyExists(string $name) : boolean 
if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}
Parameters
$name : string

Name der Eigenschaft

Return values
boolean

receive()

Empfang der Daten

public receive() : string 
$client = new Alvine\Net\Client('mailserver', 25);
$client->connect();
echo $client->receive();
$client->send("QUIT\r\n");
Tags
throws
SocketException

Kein Socket vorhanden oder Timeout

Return values
string —

Daten die Empfangen wurden empfangen

send()

Senden

public send(string $data) : Client

Daten über die Netzwerkverbindung senden.

Parameters
$data : string

Zu sendende Daten.

Tags
throws
SocketException

Kein Socket vorhanden

Return values
Client —

Zeiger auf Objekt

setConnectionMode()

Modus des Sockets

public setConnectionMode(integer $mode) : Socket

Setzt den Verbindungsmodus entweder auf Socket::NONBLOCKING (nicht blockierend) oder auf Socket::BLOCKING (blockierend)

Parameters
$mode : integer

Modus

Return values
Socket —

Dieses Objekt

checkAndAdjustSerialisation()

Dealing with versions

protected checkAndAdjustSerialisation(array $serialization) : array<string|int, mixed>

This method checks an object and ideally repairs older copies. If an old copy cannot be restored be restored, an exception is thrown.

This method must be overridden by the derived classes. be overridden. In the derived class, * the parent method should be called. the parent method should be called.

Parameters
$serialization : array

Daten des serialisiertes Objekts

Tags
throws
UnserializeException

Keine Übereinstimmung

Return values
array<string|int, mixed>

dealWithFwriteError()

Diese Funktion kann von abgeleiteten Klassen überschrieben werden, um zu entscheiden ob man im Falle eines fwrite-Errors abbricht, fortfährt oder eine Exception wirft.

protected dealWithFwriteError(IOException $e) : int

Das Standardverhalten ist eine Exception.

Parameters
$e : IOException
Return values
int

getInternalSocketContents()

Gekapselter Funktionsaufruf für stream_get_contents

protected getInternalSocketContents(resource $handle, integer $maxlength) : string

Diese Methode kann in den Unit-Tests für das mocking überschrieben werden.

Parameters
$handle : resource
$maxlength : integer
Return values
string —

Daten

getInternalSocketStatus()

Gekapselter Funktionsaufruf für socket_get_status

protected getInternalSocketStatus(Resource $socket) : array

Diese Methode kann in den Unit-Tests für das mocking überschrieben werden.

Parameters
$socket : Resource
Return values
array

isReceivedFinished()

Prüft, ob die Empfangenen Daten ausreichen und gibt false oder true zurück. Wird true zurückgegeben beendet der Socket das Empfangen der Daten.

protected isReceivedFinished() : boolean
Return values
boolean —

Abbruchbedingung

processReceiveBuffer()

Ermöglicht das überarbeiten der empfangenen Daten, insbesondere bei Clients die ein Long-Polling verwenden.

protected processReceiveBuffer() : Socket

Wichtig: Diese Funktion wird innerhalb der receive-Queue und vor Socket::isReceivedFinished() aufgerufen. Wird Socket::receiveBuffer bearbeitet, so muss unter Umständen Socket::isReceivedFinished() darauf abgestimmt werden.

Return values
Socket 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results