diff --git a/reference/stream/functions/stream-socket-pair.xml b/reference/stream/functions/stream-socket-pair.xml index 1046452717..4c74b37eb4 100755 --- a/reference/stream/functions/stream-socket-pair.xml +++ b/reference/stream/functions/stream-socket-pair.xml @@ -1,27 +1,137 @@ - - - - stream_socket_pair - - Creates a pair of connected, indistinguishable socket streams - - - - Description - - arraystream_socket_pair - intdomain - inttype - intprotocol - + + + + stream_socket_pair + + Creates a pair of connected, indistinguishable socket streams + + + + &reftitle.description; + + arraystream_socket_pair + intdomain + inttype + intprotocol + + + stream_socket_pair creates a pair of connected, + indistinguishable socket streams. This function is commonly used in IPC + (Inter-Process Communication). + + + + + &reftitle.parameters; + + + + domain + + + The protocol family to be used: STREAM_PF_INET, + STREAM_PF_INET6 or + STREAM_PF_UNIX + + + + + type + + + The type of communication to be used: + STREAM_SOCK_DGRAM, + STREAM_SOCK_RAW, + STREAM_SOCK_RDM, + STREAM_SOCK_SEQPACKET or + STREAM_SOCK_STREAM + + + + + protocol + + + The protocol to be used: STREAM_IPPROTO_ICMP, + STREAM_IPPROTO_IP, + STREAM_IPPROTO_RAW, + STREAM_IPPROTO_TCP or + STREAM_IPPROTO_UDP + + + + + + + + Please consult the Streams constant + list for further details on each constant. + + + + + + &reftitle.returnvalues; + + Returns an array with the two socket resources on success, or + &false; on failure. + + + + + &reftitle.examples; + + + A <function>stream_socket_pair</function> example - stream_socket_pair creates a pair of connected, - indistinguishable socket streams. This function is commonly used in IPC - (InterProcess Communication). + This example shows the basic usage of + stream_socket_pair in Inter-Process Comunication. - - + + +]]> + + &example.outputs.similar; + + + + + + + +