Main Content

configureTerminator

Set terminator for ASCII string communication with remote host over TCP/IP

Description

example

configureTerminator(t,terminator) defines the terminator for both read and write communications with the remote host specified by the TCP/IP client t. Allowed terminator values are "LF" (default), "CR", "CR/LF", and integer values from 0 to 255. The syntax sets the Terminator property of t.

After you set the terminator, use writeline and readline to write and read ASCII terminated string data.

example

configureTerminator(t,readterminator,writeterminator) defines separate terminators for read and write communications.

Examples

collapse all

Create a TCP/IP client called t, using the IP address 172.28.154.231 and port 4012.

t = tcpclient("172.28.154.231",4012)
t = 

  tcpclient with properties:

              Address: '172.28.154.231'
                 Port: 4012
    NumBytesAvailable: 0

  Show all properties, functions

Set both the read and write terminators to "CR/LF".

configureTerminator(t,"CR/LF")

Confirm the change.

t.Terminator
ans = 
"CR/LF"

Create a TCP/IP client called t, using the IP address 172.28.154.231 and port 4012.

t = tcpclient("172.28.154.231",4012)
t = 

  tcpclient with properties:

              Address: '172.28.154.231'
                 Port: 4012
    NumBytesAvailable: 0

  Show all properties, functions

Set the read terminator to "CR" and the write terminator to 10.

configureTerminator(t,"CR",10)

Confirm the change.

t.Terminator
ans=1×2 cell array
    {["CR"]}    {[10]}

The first element in the array is the read terminator and the second is the write terminator.

Create a TCP/IP client connection called t, connecting to a TCP/IP echo server with port 4000. To do so, you must have an echotcpip server running on port 4000.

echotcpip("on",4000)
t = tcpclient("localhost",4000)
t = 
  tcpclient with properties:

              Address: 'localhost'
                 Port: 4000
    NumBytesAvailable: 0

  Show all properties, functions

Check the default ASCII terminator.

t.Terminator
ans = 
"LF"

Set the terminator to "CR" and write a string of ASCII data. The writeline function automatically appends the terminator to the data.

configureTerminator(t,"CR")
writeline(t,"hello")

Write another string of ASCII data with the terminator automatically appended.

writeline(t,"world")

Since the client is connected to an echo server, the data you write to the server is returned to the client. Read a string of ASCII data. The readline function returns data until it reaches a terminator.

readline(t)
ans = 
"hello"

Read a string of ASCII data again to return the second string that you wrote.

readline(t)
ans = 
"world"

Close the echo server and clear the TCP/IP client connection.

echotcpip("off")
clear t

Input Arguments

collapse all

TCP/IP client, specified as a tcpclient object.

Example: configureTerminator(t,"CR/LF") sets the terminator value for the TCP/IP client t.

ASCII terminator for read and write communication, specified as "LF", "CR", "CR/LF", or a numeric integer value from 0 to 255. Use this form when setting the same terminator for both read and write. When reading from the remote host with a terminator value of "CR/LF", the read terminates on the occurrence of CR and LF together. When writing to the remote host with a terminator value of "CR/LF", the write terminates by adding both CR and LF. This input argument sets the Terminator property.

Example: configureTerminator(t,"CR/LF") sets both the read and write terminators to "CR/LF".

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | char | string

ASCII terminators for read or write communication, specified as "LF", "CR", "CR/LF", or a numeric integer value from 0 to 255. Use this form when setting different terminators for read and write. When reading from the remote host with a terminator value of "CR/LF", the read terminates on the occurrence of CR and LF together. When writing to the remote host with a terminator value of "CR/LF", the write terminates by adding both CR and LF. This input argument sets the Terminator property.

Example: configureTerminator(t,"CR",10) sets the read terminator to "CR" and write terminator to 10.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | char | string

Introduced in R2020b