In PHP, stream_socket_sendto() is useful when your application needs a specific operation rather than manually reproducing it. Sends bytes to a socket stream, optionally specifying a peer endpoint.
Stream functions work with PHP stream resources, wrappers, contexts or custom filters. Not every wrapper supports every operation.
What Is stream_socket_sendto() in PHP?
Sends bytes to a socket stream, optionally specifying a peer endpoint.
Signature:
stream_socket_sendto($socket, string $data, int $flags = 0, string $address = ''): int|falseParameters:
$socket— Existing connected or bound socket stream.$data— Raw bytes or text passed to the operation.$flags— Bitmask controlling behavior. Combine only flags documented for this function.$address— Socket transport URI or endpoint address.
Return value: int|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"); }
stream_socket_sendto($client, "Hello");
echo fread($accepted, 5);
fclose($accepted); fclose($client); fclose($server);
The important operation is stream_socket_sendto(). Sends bytes to a socket stream, optionally specifying a peer endpoint.
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"); }
stream_socket_sendto($client, "Other");
echo fread($accepted, 5);
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"); }
stream_socket_sendto($client, "Hello");
echo fread($accepted, 5);
fclose($accepted); fclose($client); fclose($server);
Practical note: Sends bytes to a socket stream, optionally specifying a peer endpoint.
Important Behavior and Edge Cases
- Sends bytes to a socket stream, optionally specifying a peer endpoint.
- 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_sendto() | sends data through a socket. |
stream_socket_recvfrom() | receives data from a socket. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
Assuming stream_socket_sendto() can be used without its required setup | Provide the correct file, stream, state, key or object before calling it; Sends bytes to a socket stream, optionally specifying a peer endpoint. |
| 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_sendto()sends bytes to a socket stream, optionally specifying a peer endpoint.- 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: Sends bytes to a socket stream, optionally specifying a peer endpoint. Build in error handling and use this function where its specific behavior matches the application requirements.