SOCKETCONNECT - Revision history

Admin at 19:27, 17 January 2017

2017-01-17T19:27:13Z

Admin at 18:09, 15 June 2015

2015-06-15T18:09:44Z

Admin at 18:09, 15 June 2015

2015-06-15T18:09:12Z

Admin: Created page with "= Action = Establishes a connection to a TCP/IP server. &nbs..."

2013-02-12T17:06:31Z

Created page with "= Action = Establishes a connection to a TCP/IP server. &nbs..."

New page

= Action =

Establishes a connection to a TCP/IP server.

 

 

= Syntax =

Result = SOCKETCONNECT(socket, IP, port)

 

 

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

| valign="top" width="100%" style="width: 549px; border: 1px solid rgb(0, 0, 0);" |
A byte that is assigned with 0 when the connection succeeded. It will return 1 when an error occurred.

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

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

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

| valign="top" width="100%" style="width: 549px; border: 1px solid rgb(0, 0, 0);" |
The IP number of the server you want to connect to.

 

This may be a number like 192.168.0.2 or a LONG variable that is assigned with an IP number.

 

Note that the LSB of the LONG, must contain the MSB of the IP number.

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

| valign="top" width="100%" style="width: 549px; border: 1px solid rgb(0, 0, 0);" |
The port number of the server you are connecting to.

|}
</div>
 

You can only connect to a server. Standardized servers have dedicated port numbers. For example, the HTTP protocol(web server) uses port 80.

 

After you have established a connection the server might send data. This depends entirely on the used protocol. Most servers will send some welcome text, this is called a banner.

 

You can send or receive data once the connection is established.

 

The server might close the connection after this or you can close the connection yourself. This also depends on the protocol.

 

You need to obtain a valid socket first with the GETSOCKET function.

 

 

= See also =

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

 

 

= Example =

 <source lang="bascomavr">
'-----------------------------------------------------------------------------------------
'name : servertest_SPI.bas
'copyright : (c) 1995-2012, MCS Electronics
'purpose : start the easytcp after the chip is programmed
' and create 2 connections
'micro : Mega88
'suited for demo : yes
'commercial addon needed : no
'-----------------------------------------------------------------------------------------

$regfile = "m88def.dat" ' specify the used micro
$crystal = 8000000 ' used crystal frequency
$baud = 19200 ' use baud rate

$hwstack = 128 ' default use 32 for the hardware stack
$swstack = 128 ' default use 10 for the SW stack
$framesize = 128 ' default use 40 for the frame space

Config Spi = Hard , Interrupt = Off , Data Order = Msb , Master = Yes , Polarity = Low , Phase = 0 , Clockrate = 4 , Noss = 0
'Init the spi pins
Spiinit
' xram access
Print "Init , set IP to 192.168.1.70" ' display a message
Enable Interrupts ' before we use config tcpip , we need to enable the interrupts
Config Tcpip = Int1 , Mac = 12.128.12.34.56.78 , Ip = 192.168.1.70 , Submask = 255.255.255.0 , Gateway = 192.168.1.1 , Localport = 1000 , Tx = $55 , Rx = $55 , Chip = W5100 , Spi = 1

Dim Bclient As Byte ' socket number
Dim Idx As Byte
Dim Result As Word , Result2 As Word ' result
Dim S As String * 80
Dim Flags As Byte
Dim Peer As Long
Dim L As Long

Do
Waitms 1000
For Idx = 0 To 3
Result = Socketstat(idx , 0) ' get status
Select Case Result
Case Sock_established
If Flags.idx = 0 Then ' if we did not send a welcome message yet
Flags.idx = 1
Result = Tcpwrite(idx , "Hello from W5100A{013}{010}") ' send welcome
End If
Result = Socketstat(idx , Sel_recv) ' get number of bytes waiting
Print "Received : " ; Result
If Result > 0 Then
Do
Print "Result : " ; Result
Result = Tcpread(idx , S)
Print "Data from client: " ; Idx ; " " ; Result ; " " ; S
Peer = Getdstip(idx)
Print "Peer IP " ; Ip2str(peer)
Print "Peer port : " ; Getdstport(idx)
'you could analyse the string here and send an appropiate command
'only exit is recognized
If Lcase(s) = "exit" Then
Closesocket Idx
Elseif Lcase(s) = "time" Then
Result2 = Tcpwrite(idx , "12:00:00{013}{010}") ' you should send date$ or time$
End If
Loop Until Result = 0
End If
Case Sock_close_wait
Print "close_wait"
Closesocket Idx
Case Sock_closed
Print "closed"
Bclient = Getsocket(idx , Sock_stream , 5000 , 64) ' get socket for server mode, specify port 5000
Print "Socket " ; Idx ; " " ; Bclient

Socketlisten Idx
Print "Result " ; Result
Flags.idx = 0 ' reset the hello message flag
Case Sock_listen 'this is normal
Case Else
Print "Socket status : " ; Result
End Select
Next
Loop

End
</source> {{Languages}}

[[Category:BASCOM Language Reference]]

@@ Line 63: / Line 63: @@
 By default, when you create a connection, the code waits for the connect flag. But waiting will block program execution. When you specify, not to wait, the code returns immediately. But you must use&nbsp;[[SOCKETSTAT]]&nbsp;to determine the outcome of the socketconnect.
-NOWAIT parameter is implemented for :
+NOWAIT parameter is implemented for&nbsp;:
 - W5500

@@ Line 9: / Line 9: @@
 = <span class="f_Header">Syntax</span> =
-Result =&nbsp;<span class="f_Syntax">SOCKETCONNECT</span>(socket, IP, port)
+<span style="font-size: 13.3333330154419px;">Result =&nbsp;</span><span class="f_Syntax" style="font-size: 13.3333330154419px;">SOCKETCONNECT</span><span style="font-size: 13.3333330154419px;">(socket, IP, port [,nowait])</span>
 <span style="font-family: Arial;">&nbsp;</span>

@@ Line 16: / Line 16: @@
 = <span class="f_Header">Remarks</span> =
-<div style="padding: 0px; margin: 0px 0px 0px 4px;">
+<div style="padding: 0px; margin: 0px 0px 0px 4px;"><div style="font-size: 13.3333330154419px; 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="9%" style="width: 51px; border: 1px solid rgb(0, 0, 0);" |
+| valign="top" width="16%" style="width: 94px; border: 1px solid rgb(0, 0, 0);" |
 Result
-| valign="top" width="100%" style="width: 549px; border: 1px solid rgb(0, 0, 0);" |
+| valign="top" width="100%" style="width: 506px; border: 1px solid rgb(0, 0, 0);" |
 A byte that is assigned with 0 when the connection succeeded. It will return 1 when an error occurred.
 |- style="vertical-align: top;"
-| valign="top" width="9%" style="width: 51px; border: 1px solid rgb(0, 0, 0);" |
+| valign="top" width="16%" style="width: 94px; border: 1px solid rgb(0, 0, 0);" |
 socket
-| valign="top" width="100%" style="width: 549px; border: 1px solid rgb(0, 0, 0);" |
+| valign="top" width="100%" style="width: 506px; border: 1px solid rgb(0, 0, 0);" |
 The socket number in the range of 0-3. Or 0-7 for W5200/W5300.
 |- style="vertical-align: top;"
-| valign="top" width="9%" style="width: 51px; border: 1px solid rgb(0, 0, 0);" |
+| valign="top" width="16%" style="width: 94px; border: 1px solid rgb(0, 0, 0);" |
 IP
-| valign="top" width="100%" style="width: 549px; border: 1px solid rgb(0, 0, 0);" |
+| valign="top" width="100%" style="width: 506px; border: 1px solid rgb(0, 0, 0);" |
 The IP number of the server you want to connect to.
@@ Line 48: / Line 48: @@
 |- style="vertical-align: top;"
-| valign="top" width="9%" style="width: 51px; border: 1px solid rgb(0, 0, 0);" |
+| valign="top" width="16%" style="width: 94px; border: 1px solid rgb(0, 0, 0);" |
 Port
-| valign="top" width="100%" style="width: 549px; border: 1px solid rgb(0, 0, 0);" |
+| valign="top" width="100%" style="width: 506px; border: 1px solid rgb(0, 0, 0);" |
 The port number of the server you are connecting to.
 |}
@@ Line 75: / Line 88: @@
 You need to obtain a valid socket first with the GETSOCKET function.
+</div>
-<span style="font-family: Arial;">&nbsp;</span>
-−
-<span style="font-family: Arial;">&nbsp;</span>
 = <span class="f_Header">See also</span> =