socket_write
The function socket_write() writes to the socket from the given data .
Parameters
The optional parameter length can specify an alternate length of bytes written to the socket. If this length is greater than the buffer length, it is silently truncated to the length of the buffer.
Return Values
Returns the number of bytes successfully written to the socket or false on failure. The error code can be retrieved with socket_last_error() . This code may be passed to socket_strerror() to get a textual explanation of the error.
Note:
It is perfectly valid for socket_write() to return zero which means no bytes have been written. Be sure to use the === operator to check for false in case of an error.
Changelog
Version | Description |
---|---|
8.0.0 | socket is a Socket instance now; previously, it was a resource . |
8.0.0 | length is nullable now. |
Notes
Note:
socket_write() does not necessarily write all bytes from the given buffer. It’s valid that, depending on the network buffers etc., only a certain amount of data, even one byte, is written though your buffer is greater. You have to watch out so you don’t unintentionally forget to transmit the rest of your data.
See Also
- socket_accept() — Accepts a connection on a socket
- socket_bind() — Binds a name to a socket
- socket_connect() — Initiates a connection on a socket
- socket_listen() — Listens for a connection on a socket
- socket_read() — Reads a maximum of length bytes from a socket
- socket_strerror() — Return a string describing a socket error
User Contributed Notes 8 notes
Here we have the same function to write a socket but with improved performance.
If the messager are not larger, they will be written entirely with a single socket_write() call. And is not needed to call the substr() function for the first bucle.
$st = «Message to sent» ;
$length = strlen ( $st );
$sent = socket_write ( $socket , $st , $length );
// Check if the entire message has been sented
if ( $sent < $length )
// If not sent the entire message.
// Get the part of the message that has not yet been sented as message
$st = substr ( $st , $sent );
// Get the length of the not sented part
$length -= $sent ;
sending a few mbs or more results in incomplete transfers, send data in a loop and chunks instead, socket_write reports complete write even though it is only a partial transfer, possibly because of buffer overrun somewhere.
$blocksize=10000;
for ($a=0;$a <$strlen;$a+=$blocksize)<
$part=substr($msg,$a,$blocksize);
$transferred=socket_write($socket,$part,strlen($part));
$totaltransferred+=$transferred;
>
if ($totaltransferred <$strlen)<
echo «incomplete transfer»;
>
I often read in php docs users not checking for the php function returned value, and in the case of socket_write, I could not see here in the comment anyone botering to read on the socket the server reply.
Then one user thought it would be a good idea to use usleep after a socket_write on a smtp connection.
Actually, if you check the server reply, not only will it give time for the server to reply before you write again on the socket, but also this is a great opportunity to check what the server replied you.
For instance, for smtp connection :
In this example MAIL_SERVER, MAIL_PORT and DEBUG are constants I defined.
function sendmail ( $param )
<
$from = & $param [ ‘from’ ];
$to = & $param [ ‘to’ ];
$message = & $param [ ‘data’ ];
$isError = function( $string )
<
if( preg_match ( ‘/^((\d)(\d))/’ , $string , $matches ) )
<
if( $matches [ 2 ] == 4 || $matches [ 2 ] == 5 ) return( $matches [ 1 ] );
>
else
<
return( false );
>
>;
try
<
$socket = null ;
if( ( $socket = socket_create ( AF_INET , SOCK_STREAM , SOL_TCP ) ) == false )
<
throw new Exception ( sprintf ( «Unable to create a socket: %s» , socket_strerror ( socket_last_error () ) ) );
>
if( ! socket_connect ( $socket , MAIL_SERVER , MAIL_PORT ) )
<
throw new Exception ( sprintf ( «Unable to connect to server %s: %s» , MAIL_SERVER , socket_strerror ( socket_last_error () ) ) );
>
$read = socket_read ( $socket , 1024 );
if( $read == false )
<
throw new Exception ( sprintf ( «Unable to read from socket: %s» , socket_strerror ( socket_last_error () ) ) );
>
if( socket_write ( $socket , sprintf ( «HELO %s\r\n» , gethostname () ) ) === false )
<
throw new Exception ( sprintf ( «Unable to write to socket: %s» , socket_strerror ( socket_last_error () ) ) );
>
$read = socket_read ( $socket , 1024 );
if( $read == false )
<
throw new Exception ( sprintf ( «Unable to read from socket: %s» , socket_strerror ( socket_last_error () ) ) );
>
else
<
if( ( $errCode = $isError ( $read ) ) ) throw new Exception ( «Server responded with an error code $errCode » );
>
if( socket_write ( $socket , sprintf ( «MAIL FROM: %s\r\n» , $from ) ) === false )
<
throw new Exception ( sprintf ( «Unable to write to socket: %s» , socket_strerror ( socket_last_error () ) ) );
>
$read = socket_read ( $socket , 1024 );
if( $read == false )
<
throw new Exception ( sprintf ( «Unable to read from socket: %s» , socket_strerror ( socket_last_error () ) ) );
>
else
<
if( ( $errCode = $isError ( $read ) ) ) throw new Exception ( «Server responded with an error code $errCode » );
>
/* And some more code, but not enough place in comment */
return( $totalWriten );
>
catch( Exception $e )
<
$ERROR = sprintf ( «Error sending mail message at line %d. » , $e -> getLine () ) . $e -> getMessage ();
return( false );
>
>
from http://www.manualy.sk/sock-faq/unix-socket-faq-2.html
read() is equivalent to recv() with a flags parameter of 0. Other values for the flags parameter change the behaviour of recv(). Similarly, write() is equivalent to send() with flags == 0.
If you connect to a Server in a way like you do with telnet or some similar protokoll you may have problems with sending data to the server. I found out that at some servers there is a different between:
socket_write ( $my_socket , $line , strlen ( $line ));
socket_write ( $my_socket , «\r\n» , strlen ( «\r\n» ));
?>
witch worked at least, and
socket_write ( $my_socket , $line . «\r\n» , strlen ( $line . «\r\n» ));
?>
wich made the server stop sending any data.
I hope this helps to save a lot of time. I needed about two days to find out, that this was the problem 😉
Some clients (Flash’s XMLSocket for example) won’t fire a read event until a new line is recieved.
/*
* Write to a socket
* add a newline and null character at the end
* some clients don’t read until new line is recieved
*
* try to send the rest of the data if it gets truncated
*/
function write (& $sock , $msg ) <
$msg = » $msg \n\0″ ;
$length = strlen ( $msg );
while( true ) <
$sent = socket_write ( $sock , $msg , $length );
if( $sent === false ) <
return false ;
>
if( $sent < $length ) <
$msg = substr ( $msg , $sent );
$length -= $sent ;
print( «Message truncated: Resending: $msg » );
> else <
return true ;
>
>
return false ;
>
?>
Hi,
if you got same problems like i have
@ socket_write ( $xd , «Good Bye!\n\r» );
@ socket_shutdown ( $xd , 2 );
@ socket_close ( $xd );
?>
wont’tx send «Good Bye!\n\r» to the opened socket.
but if you put a
usleep or something like echo «»;
between write and shutdown its working.
stream_socket_sendto
The address specified when the socket stream was created will be used unless an alternate address is specified in address .
If specified, it must be in dotted quad (or [ipv6]) format.
Return Values
Returns a result code, as an integer, or false on failure.
Examples
Example #1 stream_socket_sendto() Example
/* Open a socket to port 1234 on localhost */
$socket = stream_socket_client ( ‘tcp://127.0.0.1:1234’ );
?php
/* Send ordinary data via ordinary channels. */
fwrite ( $socket , «Normal data transmit.» );
/* Send more data out of band. */
stream_socket_sendto ( $socket , «Out of Band data.» , STREAM_OOB );
/* Close it up */
fclose ( $socket );
?>
See Also
- stream_socket_recvfrom() — Receives data from a socket, connected or not
- stream_socket_client() — Open Internet or Unix domain socket connection
- stream_socket_server() — Create an Internet or Unix domain server socket
User Contributed Notes 1 note
The return appears to be the size in bytes of the data written to the socket, or -1 on failure (this could be because of non blocking)
- Stream Functions
- stream_bucket_append
- stream_bucket_make_writeable
- stream_bucket_new
- stream_bucket_prepend
- stream_context_create
- stream_context_get_default
- stream_context_get_options
- stream_context_get_params
- stream_context_set_default
- stream_context_set_option
- stream_context_set_params
- stream_copy_to_stream
- stream_filter_append
- stream_filter_prepend
- stream_filter_register
- stream_filter_remove
- stream_get_contents
- stream_get_filters
- stream_get_line
- stream_get_meta_data
- stream_get_transports
- stream_get_wrappers
- stream_is_local
- stream_isatty
- stream_notification_callback
- stream_register_wrapper
- stream_resolve_include_path
- stream_select
- stream_set_blocking
- stream_set_chunk_size
- stream_set_read_buffer
- stream_set_timeout
- stream_set_write_buffer
- stream_socket_accept
- stream_socket_client
- stream_socket_enable_crypto
- stream_socket_get_name
- stream_socket_pair
- stream_socket_recvfrom
- stream_socket_sendto
- stream_socket_server
- stream_socket_shutdown
- stream_supports_lock
- stream_wrapper_register
- stream_wrapper_restore
- stream_wrapper_unregister
socket_send
Функция socket_send () отправляет байты length в сокет socket из data .
Parameters
Буфер,содержащий данные,которые будут отправлены на удаленный хост.
Количество байтов, которые будут отправлены на удаленный хост из data .
Значением flags может быть любая комбинация следующих флагов, соединенных бинарным оператором ИЛИ ( | ).
Возможные значения flags
MSG_OOB Отправьте OOB (внеполосные)данные. MSG_EOR Укажите рекордную отметку.Отправленные данные завершают запись. MSG_EOF Закройте сторону отправителя и включите соответствующее уведомление в конце отправленных данных.Отправленные данные завершают транзакцию. MSG_DONTROUTE Обходная маршрутизация,используйте прямой интерфейс. Return Values
socket_send () возвращает количество отправленных байтов или false в случае ошибки.
Changelog
See Also
PHP 8.2
(PHP 5 5.5.0,7,8)socket_recvmsg Чтение сообщения Эта функция в настоящее время не документирована;доступен только список ее аргументов.
(PHP 4 4.1.0,5,7,8)socket_select Выполняет системный вызов на заданных массивах сокетов с заданным таймаутом socket_select()принимает массивы сокетов и
(PHP 5 5.5.0,7,8)socket_sendmsg a message Эта функция в настоящее время не документирована;доступен только список ее аргументов.
(PHP 4 4.1.0,5,7,8)socket_sendto Отправляет сообщение независимо от того,есть соединение или нет Функция socket_sendto()отправляет байт длины из данных через порт