Closes a socket and releases underlying OS resources. This guide demonstrates its use in PHP code and explains when the result or side effect needs extra checks.
What It Does
Closes a socket and releases underlying OS resources.
Syntax and Parameters
The examples below show a real call to socket_close with suitable arguments. Read the function call in context: its connection, handle, input data or other prerequisites are created before use.
Requirements: Sockets extension; operating-system networking support.
These examples are for an isolated development environment. Hostnames, credentials and remote paths must be replaced with your approved configuration.
Example 1: Core Behavior
Use local loopback or a connected socket pair to avoid unintended public network exposure.
<?php
$sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
if ($sock === false) throw new RuntimeException("Socket creation failed");
socket_close($sock);
echo "Closed";
Observe the returned value or changed resource state. A successful function call can still require additional checks before a higher-level operation is considered successful.
Example 2: Alternative or Failure Case
The operation may return a status or a partial byte count depending on timing and transport.
<?php
$sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
if ($sock === false) throw new RuntimeException("Socket creation failed");
// Configure an operation-specific timeout for this test.
socket_set_option($sock, SOL_SOCKET, SO_RCVTIMEO, ["sec" => 1, "usec" => 0]);
socket_close($sock);
echo "Closed";
Compare the different inputs, environment assumptions or result checks. Do not use a transport-level success value as proof that all business-level requirements were met.
Practical Example: Applying the Rule
Apply explicit timeouts and check errors before integrating the code into a long-running server.
<?php
$sock = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
if ($sock === false) throw new RuntimeException("Socket creation failed");
// Configure an operation-specific timeout for this test.
socket_set_option($sock, SOL_SOCKET, SO_RCVTIMEO, ["sec" => 2, "usec" => 0]);
socket_close($sock);
echo "Closed";
In an application, convert low-level failures into controlled responses and log only non-sensitive diagnostic context.
Important Behavior and Edge Cases
Further operations on the same Socket object will fail after close.
Network operations can block or read/write only part of a message. Treat end-of-stream, timeout and transient errors separately.
Comparison with Related Functions or Patterns
| Approach | When it differs |
|---|---|
| socket_close | Closes a socket and releases underlying OS resources. |
| Related API or pattern | socket_shutdown optionally closes read or write direction before close. |
Common Beginner Mistakes
| Mistake | Correct approach |
|---|---|
| Omitting address-family checks or timeouts when handling socket resources | Further operations on the same Socket object will fail after close. |
| Substituting a related API without checking its semantics | socket_shutdown optionally closes read or write direction before close. |
Key Takeaways
- Closes a socket and releases underlying OS resources.
- Further operations on the same Socket object will fail after close.
- socket_shutdown optionally closes read or write direction before close.
Select this API or pattern based on its documented behavior and the trust boundaries in your own application, and test all external integrations against their actual deployments.