Admin: 1 revision

2013-02-15T19:16:08Z

1 revision

Admin: Created page with "= Action = Returns information about a socket. ..."

2013-02-12T17:12:19Z

Created page with "= Action = Returns information about a socket. ..."

New page

== (**COPIED FROM ENGLISH PAGE**) === Action =

Returns information about a socket.

 

 

= Syntax =

Result = SOCKETSTAT( socket , mode)

 

 

= 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="14%" style="width: 81px; border: 1px solid rgb(0, 0, 0);" |
Result

| valign="top" width="100%" style="width: 519px; border: 1px solid rgb(0, 0, 0);" |
A word variable that is assigned with the result.

|- style="vertical-align: top;"
| valign="top" width="14%" style="width: 81px; border: 1px solid rgb(0, 0, 0);" |
Socket

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

|- style="vertical-align: top;"
| valign="top" width="14%" style="width: 81px; border: 1px solid rgb(0, 0, 0);" |
Mode

| valign="top" width="100%" style="width: 519px; border: 1px solid rgb(0, 0, 0);" |
A parameter which specifies what kind of information you want to retrieve.

 

SEL_CONTROL or 0 : returns the status register value

 

SEL_SEND or 1 : returns the number of bytes that might be placed into the transmission buffer. Or in other words : the free transmission buffer space.

 

SEL_RECV or 2 : returns the number of bytes that are stored in the reception buffer. Or in other words : the number of bytes received.

|}
</div>
 

The SocketStat function contains actual 3 functions. One to get the status of the connection, one to determine how many bytes you might write to the socket, and one to determine how many bytes you can read from the buffer.

 

When you specify mode 0, one of the following byte values will be returned:

 

W3100A
<div style="padding: 0px; margin: 0px 0px 0px 4px;">
{| width="634" 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="16%" bgcolor="#ffff99" style="width: 99px; background-color: rgb(255, 255, 153); border: 1px solid rgb(0, 0, 0);" |
Value

| valign="top" width="31%" bgcolor="#ffff99" style="width: 192px; background-color: rgb(255, 255, 153); border: 1px solid rgb(0, 0, 0);" |
State

| valign="top" width="61%" bgcolor="#ffff99" style="width: 331px; background-color: rgb(255, 255, 153); border: 1px solid rgb(0, 0, 0);" |
Description

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

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_CLOSED

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection closed

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

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_ARP

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Standing by for reply after transmitting ARP request

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
2

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_LISTEN

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Standing by for connection setup to the client when acting in passive mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
3

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_SYNSENT

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Standing by for SYN,ACK after transmitting SYN for connecting setup when acting in active mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
4

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_SYNSENT_ACK

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection setup is complete after SYN,ACK is received and ACK is transmitted in active mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
5

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_SYNRECV

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
SYN,ACK is being transmitted after receiving SYN from the client in listen state, passive mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
6

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_ESTABLISHED

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection setup is complete in active, passive mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
7

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_CLOSE_WAIT

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
8

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_LAST_ACK

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
9

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_FIN_WAIT1

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
10

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_FIN_WAIT2

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
11

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_CLOSING

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
12

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_TIME_WAIT

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
13

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_RESET

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated after receiving reset packet from peer.

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
14

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_INIT

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Socket initializing

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

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_UDP

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Applicable channel is initialized in UDP mode.

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

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_RAW

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Applicable channel is initialized in IP layer RAW mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
17

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_UDP_ARP

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Standing by for reply after transmitting ARP request packet to the destination for UDP transmission

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
18

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_UDP_DATA

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Data transmission in progress in UDP RAW mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
19

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_RAW_INIT

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
W3100A initialized in MAC layer RAW mode

|}
</div>
 

W5100,W5200,W5300
<div style="padding: 0px; margin: 0px 0px 0px 4px;">
{| width="634" 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="16%" bgcolor="#ffff99" style="width: 99px; background-color: rgb(255, 255, 153); border: 1px solid rgb(0, 0, 0);" |
Value

| valign="top" width="31%" bgcolor="#ffff99" style="width: 192px; background-color: rgb(255, 255, 153); border: 1px solid rgb(0, 0, 0);" |
State

| valign="top" width="61%" bgcolor="#ffff99" style="width: 331px; background-color: rgb(255, 255, 153); border: 1px solid rgb(0, 0, 0);" |
Description

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

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_CLOSED

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection closed

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H11

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_ARP

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Standing by for reply after transmitting ARP request

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H14

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_LISTEN

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Standing by for connection setup to the client when acting in passive mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H15

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_SYNSENT

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Standing by for SYN,ACK after transmitting SYN for connecting setup when acting in active mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H16

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_SYNRECV

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
SYN,ACK is being transmitted after receiving SYN from the client in listen state, passive mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H17

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_ESTABLISHED

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection setup is complete in active, passive mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H1C

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_CLOSE_WAIT

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H1D

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_LAST_ACK

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H18

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_FIN_WAIT

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H1A

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_CLOSING

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H1B

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_TIME_WAIT

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Connection being terminated

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H13

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_INIT

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Socket initializing

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H22

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_UDP

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Applicable channel is initialized in UDP mode.

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H32

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_RAW

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Applicable channel is initialized in IP layer RAW mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H42

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_MACRAW

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Applicable channel is initialized in MAC layer RAW mode

|- style="vertical-align: top;"
| valign="top" width="16%" style="width: 99px; border: 1px solid rgb(0, 0, 0);" |
&H5F

| valign="top" width="31%" style="width: 192px; border: 1px solid rgb(0, 0, 0);" |
SOCK_PPOE

| valign="top" width="61%" style="width: 331px; border: 1px solid rgb(0, 0, 0);" |
Applicable channel is initialized in PPOE mode

|}
</div>
 

 

The SocketStat function is also used internal by the library.

 

For the W5300, if you use ALIGN=2, you need to take in mind that you must read the data buffer if it contains data. Do not call SocketStat again since it will read another 2 bytes to determine the received data size.

 

 

= See also =

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

 

 

= Partial Example =

 <source lang="bascomavr">
Tempw = Socketstat(i , 0)' get status
Select Case Tempw
Case Sock_established
Case Else
End Select
</source> {{Languages}}

[[Category:BASCOM Language Reference/de]]

SOCKETSTAT/de - Revision history

Admin: 1 revision

Admin: Created page with "= Action = Returns information about a socket. ..."