Admin at 22:17, 12 December 2014

2014-12-12T22:17:51Z

Admin at 17:58, 11 February 2013

2013-02-11T17:58:36Z

Admin: Created page with "= Action = Creates a socket for TCP/IP communication. ..."

2013-02-11T17:57:39Z

Created page with "= Action = Creates a socket for TCP/IP communication. ..."

New page

= Action =

Creates a socket for TCP/IP communication.

 

 

= Syntax =

Result = GETSOCKET(socket, mode, port, param)

 

 

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

| valign="top" width="100%" style="width: 494px; border: 1px solid rgb(0, 0, 0);" |
A byte that is assigned with the socket number you requested. When the operation fails, it will return 255.

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

| valign="top" width="100%" style="width: 494px; border: 1px solid rgb(0, 0, 0);" |
A numeric constant or variable with the socket number.

The socket number is in range of 0-3. And 0-7 for the W5200 and W5300.

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

| valign="top" width="100%" style="width: 494px; border: 1px solid rgb(0, 0, 0);" |
The socket mode. Use sock_stream(1), sock_dgrm(2), sock_ipl_raw(3)  or macl_raw(4). The modes are defined with constants.

The W5100,W5200,W5300 also have the sock_ppoe(5) mode.

 

For TCP/IP communication you need to specify sock_stream or the equivalent value 1.

 

For UDP communication you need to specify sock_dgrm or the equivalent value 2.

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

| valign="top" width="100%" style="width: 494px; border: 1px solid rgb(0, 0, 0);" |
This is the local port that will be used for the communication. You may specify any value you like but each socket must have it’s own local port number.

 

When you use 0, the value of LOCAL_PORT will be used.

 

LOCAL_PORT is assigned with CONFIG TCPIP.

 

After the assignment, LOCAL_PORT will be increased by 1. So the simplest way is to setup a local port with CONFIG TCPIP, and then use 0 for port.

|- style="vertical-align: top;"
| valign="top" width="18%" style="width: 106px; height: 136px; border: 1px solid rgb(0, 0, 0);" |
Param

| valign="top" width="100%" style="width: 494px; height: 136px; border: 1px solid rgb(0, 0, 0);" |
Optional parameter. Use 0 for default.

 

W3100

128 : send/receive broadcast message in UDP

64 : use register value with designated timeout value

32 : when not using no delayed ack

16: when not using silly window syndrome

 

Consult the W3100A documentation for more information.

 

W5100,W5200,W5300

128 : enable multicasting in UDP

32 : enable 'No delayed ACK' operation. Only for TCP/IP.

    In case of UDP multicast : 1 : use IGMP version 1, otherwise V 2.

 

Consult the wiznet documentation for more information.

|}
</div>
 

After the socket has been initialized you can use SocketConnect to connect to a client, or SocketListen to act as a server.

 

 

= See also =

[http://avrhelp.mcselec.com/config_tcpip.htm CONFIG TCPIP], [http://avrhelp.mcselec.com/socketconnect.htm SOCKETCONNECT], [http://avrhelp.mcselec.com/socketstat.htm SOCKETSTAT] , [http://avrhelp.mcselec.com/tcpwrite.htm TCPWRITE], [http://avrhelp.mcselec.com/tcpwritestr.htm TCPWRITESTR], [http://avrhelp.mcselec.com/tcpread.htm TCPREAD], [http://avrhelp.mcselec.com/socketclose.htm SOCKETCLOSE] , [http://avrhelp.mcselec.com/socketlisten.htm SOCKETLISTEN] ,[http://avrhelp.mcselec.com/socketdisconnect.htm SOCKETDISCONNECT]

 

 

= Partial Example =

 <source lang="bascomavr">
I = Getsocket(0 , Sock_stream , 5000 , 0)' get a new socket
</source> {{Languages}}

[[Category:BASCOM Language Reference]]

@@ Line 113: / Line 113: @@
 After the socket has been initialized you can use SocketConnect to connect to a client, or SocketListen to act as a server.
-<span style="font-family: Arial;">&nbsp;</span>
+<span style="font-family: Arial;"></span>
 <span style="font-family: Arial;">&nbsp;</span>

@@ Line 119: / Line 119: @@
 = <span class="f_Header">See also</span> =
-[http://avrhelp.mcselec.com/config_tcpip.htm CONFIG TCPIP],&nbsp;[http://avrhelp.mcselec.com/socketconnect.htm SOCKETCONNECT],&nbsp;[http://avrhelp.mcselec.com/socketstat.htm SOCKETSTAT]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/tcpwrite.htm TCPWRITE],&nbsp;[http://avrhelp.mcselec.com/tcpwritestr.htm TCPWRITESTR],&nbsp;[http://avrhelp.mcselec.com/tcpread.htm TCPREAD],&nbsp;[http://avrhelp.mcselec.com/socketclose.htm SOCKETCLOSE]&nbsp;,&nbsp;[http://avrhelp.mcselec.com/socketlisten.htm SOCKETLISTEN]&nbsp;,[http://avrhelp.mcselec.com/socketdisconnect.htm SOCKETDISCONNECT]
+[[CONFIG TCPIP]], [[SOCKETCONNECT]], [[SOCKETSTAT]] , [[TCPWRITE]], [[TCPWRITESTR]], [[TCPREAD]], [[SOCKETCLOSE]] , [[SOCKETLISTEN]] ,[[SOCKETDISCONNECT]]
 <span style="font-family: Arial;">&nbsp;</span>

GETSOCKET - Revision history

Admin at 22:17, 12 December 2014

Admin at 17:58, 11 February 2013

Admin: Created page with "= Action = Creates a socket for TCP/IP communication. ..."