Component: TCP Template (Comms: Networking)

Author	Matrix Ltd.
Version	2.2
Category	Comms: Networking

TCP Template component

Base TCP/IP component with simulation only interface to allow TCP/IP style network communications in simulation. Suitable for inheriting

Detailed description

No detailed description exists yet for this component

Examples

Additional examples can be found in the “Apps and Bundles” section of this Wiki:

Internet Application Guide

Wireless LAN Application Guide

Downloadable macro reference

	TxSendMyIP
This macro fills the specified channel's transmit buffer with 4 bytes of data representing this Internet E-Block's IP address as specified in the component's property page.
- BYTE	Channel
Specifies the communications channel 0-3
- VOID	Return

	RxMatchMyIP
This macro returns a non-zero value when the next 4 bytes of data in the specified channel's reception buffer are the same as the Internet E-block's IP address.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Return

	RxMatch_4_Bytes
This macro returns a non-zero value when the next 4 bytes of data in the specified channel's reception buffer are the same as those passed as parameters. There are similar functions that check for 2 bytes and 6 bytes.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Byte1
Specifies the value of the first byte
- BYTE	Byte2
Specifies the value of the second byte
- BYTE	Byte3
Specifies the value of the third byte
- BYTE	Byte4
Specifies the value of the fourth byte
- BYTE	Return

	SetPropertyVal
- STRING	Property
- STRING	Value
- VOID	Return

	SetMyIP
This macro sets up the Internet E-Block's own IP address. In most circumstances, this macro will not be required as the IP address setting in the component property page will remain constant throughout your application.
- BYTE	IP0
First Byte of IP address
- BYTE	IP1
Second Byte of IP address
- BYTE	IP2
Third Byte of IP address
- BYTE	IP3
Fourth Byte of IP address
- VOID	Return

	TxSendString
This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a single byte of data, or with a string of information.
- BYTE	Channel
Specifies the communications channel 0-3
- STRING	Data
Data byte to append to Tx buffer.
- VOID	Return

	SecureWrite
Attempts to write max number of bytes to the secure socket from the buffer. Returns actual number of bytes written.
- STRING	buffer
[[File:]] -	max
[[File:]] -	Return

	Connect
Attempt to connect to the given address and port. First open a socket on the local device using the Socket function and check that it is successful.
- STRING	Address
Remote destination address
- UINT	Port
Remote destination port
- BYTE	Return

	ForcePropEvent
Allows the property event to be fired, doing things like fetching the correct IP for the network interface.
- VOID	Return

	Receive
Receive data into the data buffer. Returns the number of bytes received
- STRING	Data
Data byte buffer to receive the data
- UINT	Count
Maximum number of bytes to read
- UINT	Return

	SendTo
Send data to a destination host. Returns the number of bytes sent.
- STRING	Data
Data byte buffer to send
- UINT	Count
Number of bytes to send
- STRING	Address
- UINT	Port
- UINT	Return

	SecureConnect
Connect securely to host and port. e.g. “www.bbc.co.uk:443” Returns 1 if successful, 0 if not
- STRING	host
Host:Port as string
[[File:]] -	Return

	RxReadHeader
Once data in a particular channel has been received, the header will be filled with information about the received data. This macro will return the information in the header. The idx parameter specifies which byte of information in the header to read
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Idx
Specifies the byte index to return
- BYTE	Return

	RxSkipBytes
Often when receiving data packets, it may be necessary to ignore large sections of the data. This can be achieved by reading each byte individually (and ignoring the returned data), but a better way is to use this Rx_skipbytes macro.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Count
Specifies how many bytes to skip
- VOID	Return

	CreateIPSocket
Note that sockets on up to 4 channels can be simultaneously opened and these channels are numbered 0 to 3. Note that sockets with different modes can be opened on different channels.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Protocol
Specifies which IP protocol to use
- BYTE	Broadcast
Allows broadcast type packets to be sent and received
- BYTE	Return

	SetDestination
This is used in IP and UDP modes to set the destination of the intended data transfer. The destination IP address needs to be set for both IP and UDP modes.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Dst_IP0
Specifies the first byte of an IP address
- BYTE	Dst_IP1
Specifies the second byte of an IP address
- BYTE	Dst_IP2
Specifies the third byte of an IP address
- BYTE	Dst_IP3
Specifies the fourth byte of an IP address
- BYTE	Dst_Port_Hi
Port High Byte
- BYTE	Dst_Port_Lo
Port Low Byte
- VOID	Return

	GetConsole
Obtain the console instance for the TCP/IP base.
[[File:]] -	Return

	TxStart
This macro indicates the start of data transmission for the specified buffer. In TCP mode, data transmission can only begin once the socket has become established. In other modes, data transmission can occur as soon as the socket has been opened.
- BYTE	Channel
Specifies the communications channel 0-3
- VOID	Return

	RxReadByte
A call to this macro will return a byte of data in the reception buffer of the specified channel. It will also internally increment a pointer to that data so that the next call to 'RxReadByte' (or any other read function) will read the next byte
- BYTE	Channel
- BYTE	Return

	CreateUDPSocket
This macro creates a socket for sending and receiving UDP data.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Src_Port_Hi
Port High Byte
- BYTE	Src_Port_Lo
Port Low Byte
- BYTE	Return

	Send
Send data
- STRING	Data
Data byte buffer to send
- UINT	Count
Number of bytes to send
- UINT	Return

	RxMatch_6_Bytes
This macro returns a non-zero value when the next 6 bytes of data in the specified channel's reception buffer are the same as those passed as parameters. There are similar functions that check for 2 bytes and 4 bytes.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Byte1
Specifies the value of the first byte
- BYTE	Byte2
Specifies the value of the second byte
- BYTE	Byte3
Specifies the value of the third byte
- BYTE	Byte4
Specifies the value of the fourth byte
- BYTE	Byte5
Specifies the value of the fifth byte
- BYTE	Byte6
Specifies the value of the sixth byte
- BYTE	Return

	RxMatch_2_Bytes
This macro returns a non-zero value when the next 2 bytes of data in the specified channel's reception buffer are the same as those passed as parameters. There are similar functions that check for 4 bytes and 6 bytes.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Byte1
Specifies the value of the first byte
- BYTE	Byte2
Specifies the value of the second byte
- BYTE	Return

	SecureClose
Close the secure connection
- VOID	Return

	RxReadString
A call to this macro will return a byte of data in the reception buffer of the specified channel. It will also internally increment a pointer to that data so that the next call to 'Rx_readbyte' (or any other read function) will read the next byte
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Length
- STRING	Return

	TxEnd
Once the transmit buffer has been filled with data, call this macro to actually send the data.
- BYTE	Channel
Specifies the communications channel 0-3
- VOID	Return

	Listen
Bind the socket to a port on the local host and set to listen mode. First open a socket on the local device using the Socket function and check that it is successful.
- UINT	Port
- BYTE	Return

	CreateTCPSocket
This macro creates a socket for sending and receiving TCP data.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Src_Port_Hi
Port High Byte
- BYTE	Src_Port_Lo
Port Low Byte
- BYTE	Return

	RxDataAvailable
This macro is used to check whether or not data has been received by the Internet E-Block. A return value of zero indicated that no data has been received. A positive return value indicates that data is available.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Return

	SocketOpen
Attempts to create a socket on the local device. Type =0 for TCP, =1 for UDP This must be successfully done before attempting connection with a remote destination. Returns 1 if successful, 0 if not.
- BYTE	Type
Type of socket to create
- BYTE	Return

	TxSendByte
This macro fills the specified channel's transmit buffer with data. It can fill the buffer with a single byte of data, or with a string of information.
- BYTE	Channel
- BYTE	Data
- VOID	Return

	TCPListen
This macro puts a previously opened TCP channel in "passive open" mode. This is the required mode when writing a TCP server application (e.g. a web server to display HTML web pages).
- BYTE	Channel
Specifies the communications channel 0-3
- VOID	Return

	RxFlushData
Once data reception has been completed, this macro should be called to discard the data packet and allow other data packets to be read.
- BYTE	Channel
Specifies the communications channel 0-3
- VOID	Return

	TCPConnect
This macro puts a previously opened TCP channel in "active open" mode. This is the required mode when writing a TCP client application (e.g. using SMTP to send an email).
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Dst_IP0
First Byte of IP address
- BYTE	Dst_IP1
Second Byte of IP address
- BYTE	Dst_IP2
Third Byte of IP address
- BYTE	Dst_IP3
Fourth Byte of IP address
- BYTE	Dst_Port_Hi
High Byte of destination port
- BYTE	Dst_Port_Lo
Low Byte of destination port
- BYTE	Return

	GetPropertyVal
- STRING	Property
- STRING	Return

	SocketClose
Close the socket
- VOID	Return

	SecureRead
Attempts to read max number of bytes from the secure socket into the buffer. Returns actual number of bytes read.
- STRING	buffer
[[File:]] -	max
[[File:]] -	Return

	RxMatchMyMAC
This macro returns a non-zero value when the next 6 bytes of data in the specified channel's reception buffer are the same as the Internet E-block's MAC address entered in the component's property page.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Return

	AcceptOpen
- BYTE	Return

	RxDataSize
This macro is used to detect the size of data collected by the Rx_data_available macro.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Return

	TxSendMyMAC
This macro fills the specified channel's transmit buffer with 6 bytes of data representing this Internet E-Block's MAC address as specified in the component's property page.
- BYTE	Channel
Specifies the communications channel 0-3
- VOID	Return

	CreateMACSocket
This macro creates a socket for sending and receiving Ethernet data using raw data.
- BYTE	Promiscuous
Receive everything (1) or just data bound for your MAC (0)
- BYTE	Broadcast
Allows broadcast messages to be accepted (1) or rejected (0)
- BYTE	Error
Allowsmessages with errors to be accepted (1) or rejected (0)
- BYTE	Return

	AcceptClose
Close the accept socket
- VOID	Return

	SecureInit
Call once to initialise the secure socket funtionality
- VOID	Return

	GetSocketStatus
This returns the state of the requested channel's socket.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Return

	Initialise
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
- VOID	Return

	TCPClose
When an established TCP connection has finished transmission of data, either the local application (i.e. your code) or the remote application (i.e. the application at the other end of the connection) can initiate closure of the socket.
- BYTE	Channel
Specifies the communications channel 0-3
- VOID	Return

	RxMatchMyMAC
This macro returns a non-zero value when the next 6 bytes of data in the specified channel's reception buffer are the same as the Internet E-block's MAC address entered in the component's property page.
- BYTE	Channel
Specifies the communications channel 0-3
- BYTE	Return

	RxDataSize
This macro is used to detect the size of data collected by the Rx_data_available macro.
- BYTE	Channel
Specifies the communications channel 0-3
- UINT	Return

	TxSendMyMAC
This macro fills the specified channel's transmit buffer with 6 bytes of data representing this Internet E-Block's MAC address as specified in the component's property page.
- BYTE	Channel
Specifies the communications channel 0-3
- VOID	Return

	CreateMACSocket
This macro creates a socket for sending and receiving Ethernet data using raw data.
- BYTE	Promiscuous
Receive everything (1) or just data bound for your MAC (0)
- BYTE	Broadcast
Allows broadcast messages to be accepted (1) or rejected (0)
- BYTE	Error
Allowsmessages with errors to be accepted (1) or rejected (0)
- BYTE	Return

	Initialise
Initialises the SPI connection to the TCPIP module and sets up some initial values. Flashes the LEDs on and off twice to confirm SPI comms are active. LEDs are then configured to auto functionality.
- VOID	Return

Property reference

	Properties
	Hostname
Local PC's hostname
	Network Interface
List of network interfaces connected to the PC. Sets which interface we are communicating via.
	Gateway0
Gateway IP address to the Internet, auto populated from the selected interface.
	Gateway1
Gateway IP address to the Internet, auto populated from the selected interface.
	Gateway2
Gateway IP address to the Internet, auto populated from the selected interface.
	Gateway3
Gateway IP address to the Internet, auto populated from the selected interface.
	Subnet0
Network IP subnet mask, auto populated from the selected interface.
	Subnet1
Network IP subnet mask, auto populated from the selected interface.
	Subnet2
Network IP subnet mask, auto populated from the selected interface.
	Subnet3
Network IP subnet mask, auto populated from the selected interface.
	IP0
Network IP address, auto populated from the selected interface.
	IP1
Network IP address, auto populated from the selected interface.
	IP2
Network IP address, auto populated from the selected interface.
	IP3
Network IP address, auto populated from the selected interface.
	MAC0
Network MAC address, auto populated from the selected interface.
	MAC1
Network MAC address, auto populated from the selected interface.
	MAC2
Network MAC address, auto populated from the selected interface.
	MAC3
Network MAC address, auto populated from the selected interface.
	MAC4
Network MAC address, auto populated from the selected interface.
	MAC5
Network MAC address, auto populated from the selected interface.
	Console Data
Generate Console Data
	Target
Sets a target object, to which User.Notify events will be sent when data is sent and received. Events are send with Message ID = this component's handle, Data: 1=Send, 2=Receive.
	Connections
	Simulations