abstract class Socket extends Alvine implements Observer

Implementierung einer generellen Socket-Klasse

Traits

SerializableImplementation

Constants

VERSION

Generelle Alvine-Version

APIVERSION

Version der API-Version der Klasse.

IDENTIFICATION

Identifizierung der Alvine API

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.

NONBLOCKING

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

BLOCKING

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

FWRITEERROR_STRATEGY_DONOTHING

Fehler ignorieren.

FWRITEERROR_STRATEGY_EXCEPTION

Abbrechen und Exception werfen

FWRITEERROR_STRATEGY_BREAKQUEUEANDFORWARD

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

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
protected string $protocol
protected string $host
protected int $port
protected string $receiveBuffer
protected string $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 int $timeout
protected int $connectionMode
protected State $state
protected Resource $socket
protected boolean $logFlag
protected string $log
protected int $flags
protected Context $context
protected int $blockSize
static protected array $availableTransports Unterstütze Protokolle

Methods

string
serialize()

Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.

bool
hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

bool
hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

void
unserialize(string $serialized)

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

string
__toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

from Alvine
void
__set(string $name, mixed $value)

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

from Alvine
boolean
__isset(string $name)

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

from Alvine
__unset(string $name)

Zurücksetzen von Werten

from Alvine
mixed
__get(string $name)

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.

from Alvine
getClosure(string $name)

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.

from Alvine
boolean
propertyExists(string $name)

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

from Alvine
mixed
__call(string $name, array $arguments)

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

from Alvine
boolean
isCallable(type $name)

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

from Alvine
string
getHashCode() deprecated

Die Methode Alvine::getID() verwenden!

from Alvine
string
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.

from Alvine
string
getShortID(int|null $length = null)

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.

from Alvine
boolean
equals(Alvine $object)

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.

from Alvine
Alvine
getClone(boolean $deepClone = false)

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

from Alvine
__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.

from Alvine
string
getClass()

Name der Klasse

from Alvine
boolean
isInstanceOf(object $object)

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.

from Alvine
__construct(string $host, int $port, int $timeout = null, string $protocol = 'tcp', string $path = null)

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

__destruct()

Netzwerkverbindung schliessen

connect()

Verbindung herstellen

integer
getStateCode()

Gibt den aktuellen Status des Objekts zurück

attachObserver(Observer $observer)

Fügt einen Beobachter zum Status-Objekt hinzu

detachObserver(Observer $observer)

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

setContext(Context $context)

Setzen des Context der Verbindung

createContext()

Kontext Objekt

dispose()

Netzwerkverbindung beenden

string
getLog()

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

boolean
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.

string
receive()

Empfang der Daten

processReceiveBuffer()

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

disableLogging()

Logging deaktivieren

enableLogging()

Logging aktivieren

clearReceiveBuffer()

Empfangsbuffer leeren

array
getInternalSocketStatus(Resource $socket)

Gekapselter Funktionsaufruf für socket_get_status

string
getInternalSocketContents(resource $handle, integer $maxlength)

Gekapselter Funktionsaufruf für stream_get_contents

send(string $data)

Senden

int
dealWithFwriteError(IOException $e)

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.

boolean
isConnected()

Status

setConnectionMode(integer $mode)

Modus des Sockets

string
getProtocol()

Protokoll

string
getHost()

Host

integer
getPort()

Port

string
getPath()

Path

integer
getTimeout()

Timeout

static static
getInstanceFromURI(URI $uri, integer $timeout = null)

Erstellen einer Sockeresourche über eine URI

Details

string serialize()

Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.

Soll eine abgeleitete Klasse nicht serialisierbar sein, so muss diese Methode überschrieben werden und eine Exception werfen.

Eigenschaften die mit volatile oder associated beginnen werden gesonder behandelt. Eigenschaften mit Prefix volatile werde nicht serialisiert. Bei Eigenschaften mit der Vorsilbe associated wird nur die ID des Objektes serialisiert. Wird in der Eigenschaft kein Objekt gespeichert wird eine TypeException geworfen.

Return Value

string String-Repräsentation des Objektes

bool hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

Return Value

bool

bool hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

Return Value

bool

protected checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

Diese Methode überprüft ein Objekt und repariert im idealfall ältere Kopien. Kann eine alte Kopie nicht wieder hergestellt werden, so wird eine Exeption geworfen.

Diese Methode muss von den abgeleiteten Klassen überschrieben werden. In der abgeleiteten Klasse sollte die Parent-Methode aufgerufen werden.

Parameters

array $serialization Daten des serialisiertes Objekts

Exceptions

UnserializeException Keine Übereinstimmung

void unserialize(string $serialized)

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

Parameters

string $serialized

Return Value

void

in Alvine at line 177
string __toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

echo (string) new MyObect();

Return Value

string Daten des Objekts

in Alvine at line 211
void __set(string $name, mixed $value)

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

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

string $name Name der Eigenschaft
mixed $value Wert der Eigenschaft

Return Value

void

in Alvine at line 222
boolean __isset(string $name)

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

Parameters

string $name

Return Value

boolean

in Alvine at line 231
__unset(string $name)

Zurücksetzen von Werten

Parameters

string $name

in Alvine at line 256
mixed __get(string $name)

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.

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

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Parameters

string $name Name der Eigenschaft

Return Value

mixed Wert der Eigenschaft

Exceptions

BadPropertyException

in Alvine at line 281
Closure getClosure(string $name)

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.

Parameters

string $name Name des Closure

Return Value

Closure

Exceptions

NotFoundException
BadPropertyException

in Alvine at line 307
boolean propertyExists(string $name)

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

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Parameters

string $name Name der Eigenschaft

Return Value

boolean

in Alvine at line 339
mixed __call(string $name, array $arguments)

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

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

string $name Funktionsname
array $arguments Argumente

Return Value

mixed Ergebnis des Callbacks

Exceptions

NotCallableException Exception

in Alvine at line 362
boolean isCallable(type $name)

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

if($obj->isCallable('myfunction')) {
  $obj->myfunction();
}

Parameters

type $name Name der Methode

Return Value

boolean Ergebnis

in Alvine at line 376
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

in Alvine at line 396
string 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.

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 Value

string UUID des Objektes

in Alvine at line 416
string getShortID(int|null $length = null)

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.

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

int|null $length

Return Value

string

in Alvine at line 442
boolean equals(Alvine $object)

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.

class MyObject extends Alvine {};

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

if($objA->equals($objB)) {
  // ...
}

Parameters

Alvine $object Objekt das überprüft werden soll

Return Value

boolean true wenn beide Objekte identisch sind.

in Alvine at line 463
Alvine getClone(boolean $deepClone = false)

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

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

boolean $deepClone Clone aller enthaltenen Objekte

Return Value

Alvine

See also

Alvine::__clone

in Alvine at line 475
__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.

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

in Alvine at line 493
string getClass()

Name der Klasse

class MyObject extends Alvine {};
$obj = new MyObject();

echo $obj->getClass();

Return Value

string Klassenname

See also

ClassType::getNormalizedName

in Alvine at line 518
boolean isInstanceOf(object $object)

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.

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

Die Prüfung entspricht

$this instanceof $object

Parameters

object $object

Return Value

boolean

at line 157
__construct(string $host, int $port, int $timeout = null, string $protocol = 'tcp', string $path = null)

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

Parameters

string $host IP oder Hostname, bei IPV6 müssen klammern verwendet werden.
int $port Portnummer
int $timeout Zeit in Sekunden
string $protocol Protokoll (tcp, udp, unix)
string $path Pfad

at line 184
__destruct()

Netzwerkverbindung schliessen

at line 199
abstract Socket connect()

Verbindung herstellen

Wichtig für abgeleitete Klasse ist es $this->state->connect(); zu informieren.

Return Value

Socket Zeiger auf Objekt

at line 208
integer getStateCode()

Gibt den aktuellen Status des Objekts zurück

Return Value

integer Aktueller Zustand des Objekts

See also

SocketState

at line 220
Socket attachObserver(Observer $observer)

Fügt einen Beobachter zum Status-Objekt hinzu

Parameters

Observer $observer Beobachter

Return Value

Socket Dieses Objekt

at line 233
Socket detachObserver(Observer $observer)

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

Parameters

Observer $observer Beobachter

Return Value

Socket Dieses Objekt

at line 245
Socket setContext(Context $context)

Setzen des Context der Verbindung

Parameters

Context $context context

Return Value

Socket Dieses Objekt

at line 255
protected Context createContext()

Kontext Objekt

Return Value

Context Context

at line 279
Client dispose()

Netzwerkverbindung beenden

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.

Return Value

Client Zeiger auf Objekt

See also

File
Mail

at line 309
string getLog()

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

Return Value

string

at line 320
protected boolean 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.

Return Value

boolean Abbruchbedingung

at line 342
string receive()

Empfang der Daten

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

Return Value

string Daten die Empfangen wurden empfangen

at line 386
protected Socket processReceiveBuffer()

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

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 Value

Socket

at line 395
Socket disableLogging()

Logging deaktivieren

Return Value

Socket

at line 405
Socket enableLogging()

Logging aktivieren

Return Value

Socket

at line 415
protected Socket clearReceiveBuffer()

Empfangsbuffer leeren

Return Value

Socket

at line 430
protected array getInternalSocketStatus(Resource $socket)

Gekapselter Funktionsaufruf für socket_get_status

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

Parameters

Resource $socket

Return Value

array

at line 453
protected string getInternalSocketContents(resource $handle, integer $maxlength)

Gekapselter Funktionsaufruf für stream_get_contents

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

Parameters

resource $handle
integer $maxlength

Return Value

string Daten

at line 468
Client send(string $data)

Senden

Daten über die Netzwerkverbindung senden.

Parameters

string $data Zu sendende Daten.

Return Value

Client Zeiger auf Objekt

at line 535
protected int dealWithFwriteError(IOException $e)

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.

Das Standardverhalten ist eine Exception.

Parameters

IOException $e

Return Value

int

at line 546
boolean isConnected()

Status

Ist der Socket verbunden?

Return Value

boolean Verbunden (true/false)

at line 573
Socket setConnectionMode(integer $mode)

Modus des Sockets

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

Parameters

integer $mode Modus

Return Value

Socket Dieses Objekt

at line 586
string getProtocol()

Protokoll

Return Value

string Protokoll

at line 595
string getHost()

Host

Return Value

string Host

at line 604
integer getPort()

Port

Return Value

integer Port

at line 613
string getPath()

Path

Return Value

string Path

at line 622
integer getTimeout()

Timeout

Return Value

integer Timeout

at line 642
static static getInstanceFromURI(URI $uri, integer $timeout = null)

Erstellen einer Sockeresourche über eine URI

// 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
integer $timeout

Return Value

static