Admin: 1 revision

2013-02-15T19:16:22Z

1 revision

Admin: Created page with "= Action = Write data to a socket. =
2013-02-12T18:00:39Z

Created page with "= Action = Write data to a socket. = Action =

Write data to a socket.

 

 

= Syntax =

Result = TCPWRITE( socket , var , bytes)

Result = TCPWRITE( socket , EPROM, address , bytes)

 

 

= Remarks =
<div style="padding: 0px; margin: 0px 0px 0px 4px;">
{| width="609" cellspacing="0" cellpadding="1" border="1" style="border: 2px solid rgb(0, 0, 0); border-spacing: 0px; border-collapse: collapse;"
|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 88px; border: 1px solid rgb(0, 0, 0);" |
Result

| valign="top" width="100%" style="width: 512px; border: 1px solid rgb(0, 0, 0);" |
A word variable that will be assigned with the number of bytes actually written to the socket.

 

When the free transmission buffer is large enough to accept all the data, the result will be the same as BYTES. When there is not enough space, the number of written bytes will be returned.

 

When there is no space, 0 will be returned.

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 88px; height: 16px; border: 1px solid rgb(0, 0, 0);" |
Socket

| valign="top" width="100%" style="width: 512px; height: 16px; border: 1px solid rgb(0, 0, 0);" |
The socket number you want to send data to in the range from 0-3. Or 0-7 for the W5200/W5300.

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 88px; border: 1px solid rgb(0, 0, 0);" |
Var

| valign="top" width="100%" style="width: 512px; border: 1px solid rgb(0, 0, 0);" |
A constant string like "test" or a variable.

 

When you send a constant string, the number of bytes to send does not need to be specified.

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 88px; border: 1px solid rgb(0, 0, 0);" |
Bytes

| valign="top" width="100%" style="width: 512px; border: 1px solid rgb(0, 0, 0);" |
A word variable or numeric constant that specifies how many bytes must be send.

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 88px; border: 1px solid rgb(0, 0, 0);" |
Address

| valign="top" width="100%" style="width: 512px; border: 1px solid rgb(0, 0, 0);" |
The address of the data stored in the chips internal EEPROM. You need to specify EPROM too in that case.

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 88px; border: 1px solid rgb(0, 0, 0);" |
EPROM

| valign="top" width="100%" style="width: 512px; border: 1px solid rgb(0, 0, 0);" |
An indication for the compiler so it knows that you will send data from EPROM.

|}
</div>
 

The TCPwrite function can be used to write data to a socket that is stored in EEPROM or in memory.

When you want to send data from an array, you need to specify the element : var(idx) for example.

The amount of data you can send depends on the socket TX size. With CONFIG TCPIP you can define the TX buffer size.

For example, for the W5100, the maximum TX socket size is 2 KB. In this case the maximum data size you can send is 2048 bytes.

Bigger data should be send in multiple chucks.

You should also consider the maximum packet size. If the packet size is 1460, sending more data will send multiple fragmented packets.

If you have enough RAM available, the best option is to use a buffer with the same size as the packet size. But if your memory it limited, you can let the chip handle this.

 

The following sample function demonstrates how you can send multiple chunks. The sample uses a buffer named eth_buffer() with a size of 2048 bytes.

 

  Function Write_databuf(byval Txsize As Word) As Word   Local Strt As Word   Strt = 1   Do     If Txsize > 2048 Then        Write_databuf = Tcpwrite(idx_http , Eth_buffer(strt) , 2048)        Txsize = Txsize - 2048 : Strt = Strt + 2048     Else        Write_databuf = Tcpwrite(idx_http , Eth_buffer(strt) , Txsize)       Exit Do     End If   Loop   Http_speed = Http_speed + txSize End function    

 

 

= See also =

[[CONFIG TCPIP]], [[GETSOCKET]] , [[SOCKETCONNECT]], [[SOCKETSTAT]] , [[TCPWRITESTR]], [[TCPREAD]], [[SOCKETCLOSE]] ,[[SOCKETLISTEN]], [[SOCKETDISCONNECT]]

 

 

= Example =

 <source lang="bascomavr">
Result = Tcpwrite(idx , "Hello from W3100A{013}{010}")
</source> {{Languages}}

[[Category:BASCOM Language Reference/de]]