readline

Read line of ASCII string data from remote host over TCP/IP

Since R2020b

Syntax

data = readline(t)

Description

data = readline(t) reads ASCII data until the first occurrence of the terminator from the remote host specified by the TCP/IP client t and returns data as a string without the terminator. If the function is unable to return any data within the period specified by the Timeout property of t, it returns data as a 0-by-0 double []. The function suspends MATLAB^® execution until the terminator is reached or a timeout occurs.

Examples

Write and Read Line of ASCII Data from Remote Host

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

t — TCP/IP client

tcpclient object

TCP/IP client, specified as a tcpclient object.

Example: readline(t) reads ASCII data from the remote host specified by the TCP/IP client t.

Version History

Introduced in R2020b