Main Content

configureTerminator

Set terminator for ASCII string communication with UDP socket

Since R2020b

collapse all in page

    Syntax

    configureTerminator(u,terminator)
    configureTerminator(u,readterminator,writeterminator)

    Description

    configureTerminator(u,terminator) defines the terminator for both read and write communications with the specified UDP socket. u must be a byte-type udpport object. Allowed terminator values are "LF" (default), "CR", "CR/LF", and integer values from 0 to 255. The syntax sets the Terminator property of u.

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

    example

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

    example

    Examples

    collapse all

    Create a UDP socket and set its read and write terminators to "CR/LF".

    u = udpport;
configureTerminator(u,"CR/LF")

    Confirm the change.

    u.Terminator
    ans = 

    "CR/LF"

    Create a UDP socket and set its read terminator to "CR" and its write terminator to 10.

    u = udpport;
configureTerminator(u,"CR",10)

    Confirm the change.

    u.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.

    Input Arguments

    collapse all

    Byte-type UDP socket, specified as a udpport object.

    Example: u = udpport

    Data Types: udpport object

    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 you read from the UDP socket with a terminator value of "CR/LF", the read terminates on the occurrence of CR and LF together. When you write to the UDP socket 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(u,"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 you read from the UDP socket with a terminator value of "CR/LF", the read terminates on the occurrence of CR and LF together. When you write to the UDP socket with a terminator value of "CR/LF", the write terminates by adding both CR and LF. This input argument sets the Terminator property to a cell array of {readterminator,writeterminator}.

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

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

    Version History

    Introduced in R2020b

    See Also

    Functions