PHP stream_socket_get_name() Function: Usage and Examples

In PHP, stream_socket_get_name() is useful when your application needs a specific operation rather than manually reproducing it. Returns the local or remote socket endpoint address and port as a string.

Stream functions work with PHP stream resources, wrappers, contexts or custom filters. Not every wrapper supports every operation.

What Is stream_socket_get_name() in PHP?

Returns the local or remote socket endpoint address and port as a string.

Signature:

stream_socket_get_name($socket, bool $remote): string|false

Parameters:

$socket — Existing connected or bound socket stream.
$remote — Whether to return the remote endpoint instead of the local endpoint.

Return value: string|false.

Example 1: Basic Usage

This first example shows the method or function in a minimal context. For environment-dependent operations, adapt the required path, stream or connection before running it.

<?php

$errorCode = 0;
$errorMessage = "";
$server = stream_socket_server("tcp://127.0.0.1:0", $errorCode, $errorMessage);
if ($server === false) { throw new RuntimeException($errorMessage); }
$address = stream_socket_get_name($server, false);
$client = stream_socket_client("tcp://" . $address, $errorCode, $errorMessage, 2);
if ($client === false) { fclose($server); throw new RuntimeException($errorMessage); }
$accepted = stream_socket_accept($server, 2);
if ($accepted === false) { fclose($client); fclose($server); throw new RuntimeException("Accept failed"); }
echo stream_socket_get_name($client, false);
fclose($accepted); fclose($client); fclose($server);

The important operation is stream_socket_get_name(). Returns the local or remote socket endpoint address and port as a string.

Example 2: Another Input or Scenario

The next example changes the input or surrounding context to show how the operation behaves in a second situation.

<?php

$errorCode = 0;
$errorMessage = "";
$server = stream_socket_server("tcp://127.0.0.1:0", $errorCode, $errorMessage);
if ($server === false) { throw new RuntimeException($errorMessage); }
$address = stream_socket_get_name($server, false);
$client = stream_socket_client("tcp://" . $address, $errorCode, $errorMessage, 2);
if ($client === false) { fclose($server); throw new RuntimeException($errorMessage); }
$accepted = stream_socket_accept($server, 2);
if ($accepted === false) { fclose($client); fclose($server); throw new RuntimeException("Accept failed"); }
echo stream_socket_get_name($accepted, true);
fclose($accepted); fclose($client); fclose($server);

Compare the inputs and the handling of the return value with the first example. Avoid assuming that filesystem paths, resource states or binary bytes are interchangeable.

Practical Example: Applying the Operation

This example illustrates how the operation fits into a small application workflow. Paths, streams and secrets must be created or provided securely by the calling application.

<?php

$errorCode = 0;
$errorMessage = "";
$server = stream_socket_server("tcp://127.0.0.1:0", $errorCode, $errorMessage);
if ($server === false) { throw new RuntimeException($errorMessage); }
$address = stream_socket_get_name($server, false);
$client = stream_socket_client("tcp://" . $address, $errorCode, $errorMessage, 2);
if ($client === false) { fclose($server); throw new RuntimeException($errorMessage); }
$accepted = stream_socket_accept($server, 2);
if ($accepted === false) { fclose($client); fclose($server); throw new RuntimeException("Accept failed"); }
fwrite($client, "Health check");
$buffer = fread($accepted, 12);
if ($buffer !== "Health check") { throw new RuntimeException("Unexpected response"); }
echo stream_socket_get_name($client, false);
fclose($accepted); fclose($client); fclose($server);

Practical note: Returns the local or remote socket endpoint address and port as a string.

Important Behavior and Edge Cases

Returns the local or remote socket endpoint address and port as a string.
Check failure values and exceptions; do not assume every environment supports the same stream wrapper, extension or filesystem capability.
When handling paths, streams or external input, validate inputs before using results and release resources after use.

Comparison With Related Functions

Function or Method	Behavior
`stream_socket_get_name()`	reads local or remote socket endpoint.
`stream_socket_client()`	creates a client connection.

Common Beginner Mistakes

Mistake	Correct Approach
Assuming `stream_socket_get_name()` can be used without its required setup	Provide the correct file, stream, state, key or object before calling it; Returns the local or remote socket endpoint address and port as a string.
Assuming one socket read returns the whole message	Treat socket input as a stream and frame messages explicitly; read until a known boundary or length.
Omitting timeouts and failure handling	Check false results, timeouts, and partial writes; close sockets on every error path.

Key Takeaways

stream_socket_get_name() returns the local or remote socket endpoint address and port as a string.
Use appropriate input types and verify results before continuing.
Prefer specialized, safer APIs when the operation concerns untrusted input, encryption or network traffic.

In summary: Returns the local or remote socket endpoint address and port as a string. Build in error handling and use this function where its specific behavior matches the application requirements.