Socket
abstract class Socket extends Alvine implements Observer
Implementierung einer generellen Socket-Klasse
Traits
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) |
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
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
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.
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.
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
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 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.
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
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.
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.
Neues Client-Objekt erstellen. Es wird noch keine Verbindung aufgebaut.
Netzwerkverbindung schliessen
Gibt den aktuellen Status des Objekts zurück
Diese Methode entfernt einen Beobachter von der Liste der Status-Beobchter.
Kontext Objekt
Gibt die Logdaten, falls Socket::enableLog() aufgerufen wurde, zurück.
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.
Empfang der Daten
Ermöglicht das überarbeiten der empfangenen Daten, insbesondere bei Clients die ein Long-Polling verwenden.
Logging deaktivieren
Logging aktivieren
Empfangsbuffer leeren
Gekapselter Funktionsaufruf für socket_get_status
Gekapselter Funktionsaufruf für stream_get_contents
Status
Modus des Sockets
Protokoll
Host
Port
Path
Timeout
Details
in SerializableImplementation at line 125
string
serialize()
Serialisieren
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.
in SerializableImplementation at line 197
boolean
hasAssociatedProperties()
Prüfen ob das Objekt associative Eigenschaften besitzt
in SerializableImplementation at line 209
boolean
hasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
in SerializableImplementation at line 232
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.
in SerializableImplementation at line 257
unserialize(string $serialization)
Klasse deserialisieren
Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.
in Alvine at line 178
string
__toString()
Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
echo (string) new MyObect();
in Alvine at line 212
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;
in Alvine at line 223
boolean
__isset(string $name)
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
in Alvine at line 232
__unset(string $name)
Zurücksetzen von Werten
in Alvine at line 257
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;
}
in Alvine at line 282
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.
in Alvine at line 308
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;
}
in Alvine at line 340
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!
in Alvine at line 363
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();
}
in Alvine at line 377
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
in Alvine at line 397
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)
in Alvine at line 416
string
getShortID(integer $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 hilreich um Platz zu sparen.
Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision.
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)) {
// ...
}
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
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();
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
at line 143
__construct(string $host, int $port, int $timeout = null, string $protocol = 'tcp', string $path = null)
Neues Client-Objekt erstellen. Es wird noch keine Verbindung aufgebaut.
at line 170
__destruct()
Netzwerkverbindung schliessen
at line 185
abstract Socket
connect()
Verbindung herstellen
Wichtig für abgeleitete Klasse ist es $this->state->connect(); zu informieren.
at line 194
integer
getStateCode()
Gibt den aktuellen Status des Objekts zurück
at line 219
Socket
detachObserver(Observer $observer)
Diese Methode entfernt einen Beobachter von der Liste der Status-Beobchter.
at line 241
protected Context
createContext()
Kontext Objekt
at line 265
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.
at line 295
string
getLog()
Gibt die Logdaten, falls Socket::enableLog() aufgerufen wurde, zurück.
at line 306
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.
at line 328
string
receive()
Empfang der Daten
$client = new Alvine\Net\Client('mailserver', 25);
$client->connect();
echo $client->receive();
$client->send("QUIT\r\n");
at line 372
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.
at line 381
Socket
disableLogging()
Logging deaktivieren
at line 391
Socket
enableLogging()
Logging aktivieren
at line 401
protected Socket
clearReceiveBuffer()
Empfangsbuffer leeren
at line 416
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.
at line 439
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.
at line 454
Client
send(string $data)
Senden
Daten über die Netzwerkverbindung senden.
at line 494
boolean
isConnected()
Status
Ist der Socket verbunden?
at line 521
Socket
setConnectionMode(integer $mode)
Modus des Sockets
Setzt den Verbindungsmodus entweder auf Socket::NONBLOCKING (nicht blockierend) oder auf Socket::BLOCKING (blockierend)
at line 534
string
getProtocol()
Protokoll
at line 543
string
getHost()
Host
at line 552
integer
getPort()
Port
at line 561
string
getPath()
Path
at line 570
integer
getTimeout()
Timeout
at line 590
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');