RunMat
  • Pricing
RunMat
GitHub
GitHub
Sign inTry in browser
DesktopRuntimePhysicsCADAdministrationAgent

Get RunMat updates

New releases, guides and examples.

Product+
  • Runtime
  • GPU
  • Parallel
  • Compile
  • Interop and MEX
  • Simulation
  • MCAD
  • ECAD
  • Enterprise
  • AI integrations
  • Pricing
  • Download
Math+
  • Signal processing
  • Linear algebra
  • Statistics
  • Curve fitting
  • Differential equations
  • Control systems
  • Optimization
  • Finance
  • Data and tables
  • Plotting
Physics+
  • Simulation overview
  • Structural
  • Thermal
  • Electromagnetic
  • Joule heating
  • Thermal stress
  • Acoustics
  • Fluid flow
  • Conjugate heat transfer
  • Fluid–structure
  • What is FEA
Industries+
  • Aerospace
  • Automotive and transportation
  • Defense
  • Electronics and semiconductors
  • Energy
  • Industrial machinery
  • Life sciences
  • Quantitative finance
Learn+
  • Guides
  • Docs
  • Function reference
  • Language reference
  • Migration guide
  • Changelog
  • MATLAB Online
  • MATLAB AI agent
  • For students
Compare+
  • RunMat vs MATLAB
  • RunMat vs Ansys
  • RunMat vs SOLIDWORKS
  • RunMat vs Altium
  • RunMat vs Cadence
  • RunMat vs COMSOL
  • RunMat vs Python
  • RunMat vs Julia
  • RunMat vs Physics AI
  • RunMat vs Octave
  • Benchmarks
  • MATLAB alternatives
  • All comparisons
Company+
  • About
  • Blog
  • Contact
  • Source code↗
  • License
  • Privacy
  • Terms

Product

  • Runtime
  • GPU
  • Parallel
  • Compile
  • Interop and MEX
  • Simulation
  • MCAD
  • ECAD
  • Enterprise
  • AI integrations
  • Pricing
  • Download

Math

  • Signal processing
  • Linear algebra
  • Statistics
  • Curve fitting
  • Differential equations
  • Control systems
  • Optimization
  • Finance
  • Data and tables
  • Plotting

Physics

  • Simulation overview
  • Structural
  • Thermal
  • Electromagnetic
  • Joule heating
  • Thermal stress
  • Acoustics
  • Fluid flow
  • Conjugate heat transfer
  • Fluid–structure
  • What is FEA

Industries

  • Aerospace
  • Automotive and transportation
  • Defense
  • Electronics and semiconductors
  • Energy
  • Industrial machinery
  • Life sciences
  • Quantitative finance

Learn

  • Guides
  • Docs
  • Function reference
  • Language reference
  • Migration guide
  • Changelog
  • MATLAB Online
  • MATLAB AI agent
  • For students

Compare

  • RunMat vs MATLAB
  • RunMat vs Ansys
  • RunMat vs SOLIDWORKS
  • RunMat vs Altium
  • RunMat vs Cadence
  • RunMat vs COMSOL
  • RunMat vs Python
  • RunMat vs Julia
  • RunMat vs Physics AI
  • RunMat vs Octave
  • Benchmarks
  • MATLAB alternatives
  • All comparisons

Company

  • About
  • Blog
  • Contact
  • Source code↗
  • License
  • Privacy
  • Terms
GitHubXLinkedIn

© Dystr, Inc. · RunMat v0.7.1, Nov 17, 2026

RunMat® is a registered trademark of Dystr, Inc. MATLAB® is a registered trademark of The MathWorks, Inc. RunMat is not affiliated with, endorsed by, or sponsored by The MathWorks, Inc.

/
See all docs
Builtin Reference
    • accept
    • read
    • readline
    • tcpclient
    • tcpserver
    • write

tcpserver — Create a TCP server listener for accept, read, and write workflows.

tcpserver(address,port) creates a TCP/IP listening socket, records its connection metadata, and returns a server value used by accept, read, write, and close.

Syntax

server = tcpserver(address, port)
server = tcpserver(address, port, Name, Value, ...)

Inputs

address
Type
StringScalar
Required
Yes
Description
Bind address or hostname.
port
Type
NumericScalar
Required
Yes
Description
Listening TCP port (0..65535).
name_value_pairs
Type
Any
Required
Variadic
Description
Name/Value options such as Timeout, UserData, Name, and ByteOrder.
NameTypeRequiredDefaultDescription
addressStringScalarYes—Bind address or hostname.
portNumericScalarYes—Listening TCP port (0..65535).
name_value_pairsAnyVariadic—Name/Value options such as Timeout, UserData, Name, and ByteOrder.

Returns

server
Type
Any
Description
tcpserver object with sealed authority for accept/close operations.
NameTypeDescription
serverAnytcpserver object with sealed authority for accept/close operations.

Errors

RunMat:network:UnsupportedTarget
When
A native TCP socket operation is requested in a browser target.
Message
native TCP sockets are unavailable on this target
RunMat:Cancelled
When
An invocation is cancelled before or during a pending TCP operation.
Message
TCP invocation was cancelled
RunMat:tcpserver:InvalidAddress
When
Address argument is not a valid string scalar.
Message
tcpserver: invalid address argument
IdentifierWhenMessage
RunMat:network:UnsupportedTargetA native TCP socket operation is requested in a browser target.native TCP sockets are unavailable on this target
RunMat:CancelledAn invocation is cancelled before or during a pending TCP operation.TCP invocation was cancelled
RunMat:tcpserver:InvalidAddressAddress argument is not a valid string scalar.tcpserver: invalid address argument
RunMat:tcpserver:InvalidPortPort argument is non-scalar, non-integer, non-finite, or out of range.tcpserver: invalid port argument
RunMat:tcpserver:InvalidNameValueName/Value arguments are malformed, unsupported, or have invalid values.tcpserver: invalid name-value arguments
RunMat:tcpserver:BindFailedSocket bind operation fails.tcpserver: unable to bind listener
RunMat:tcpserver:InternalErrorInternal listener metadata retrieval fails.tcpserver: internal error

Bind address, port, and options

tcpserver(address, port) binds to the requested interface; pass "0.0.0.0" or "::" to listen on every IPv4 or IPv6 adapter respectively.

The documented port range is 1 through 65535. In RunMat mode, port zero requests an ephemeral operating-system-assigned port reported by ServerPort.

The current server parser accepts finite, nonnegative double values for Timeout; unlike the client constructor it rejects Inf. ByteOrder accepts little- or big-endian text. RunMat mode additionally accepts typed-integer port and timeout values and legacy UserData and Name options.

The documented one-argument tcpserver(port) form is not implemented; provide both address and port.

Result, placement, and failures

RunMat returns a tcpserver object with a sealed session-owned listener authority, not a MATLAB handle-class implementation. Public port properties are double; ClientPort is empty until a client connects. Editing copied properties does not reconfigure the listener.

Automatically resident inputs gather through their owner. Explicit gpuArray input requires RunMat mode; the result remains host-resident. No accelerator kernel participates in socket binding.

Bind failures raise RunMat:tcpserver:BindFailed with the operating-system error message. Callback properties are not active; use accept, read, and write for explicit I/O.

Illustrative programs

Creating a loopback TCP server on a fixed port

srv = tcpserver("127.0.0.1", 55000);

disp(srv.ServerAddress)

disp(srv.ServerPort)

Expected display: 127.0.0.1

55000

Requesting an ephemeral port

srv = tcpserver("0.0.0.0", 0);

fprintf("Listening on %s:%d\n", srv.ServerAddress, srv.ServerPort)

Illustrative display: Listening on 0.0.0.0:54873 (actual port varies)

Configuring timeout and metadata

srv = tcpserver("localhost", 60000, "Timeout", 5, "UserData", struct("name", "demo"));

disp(srv.Timeout)

disp(srv.UserData.name)

Expected display: 5

demo

Assigning a custom server name

srv = tcpserver("::1", 45000, "Name", "LoopbackServer");

disp(srv.Name)

Expected display: LoopbackServer

Selecting big-endian byte order

srv = tcpserver("127.0.0.1", 45001, "ByteOrder", "big-endian");

disp(srv.ByteOrder)

Expected display: big-endian

Handling an invalid port

try

srv = tcpserver("127.0.0.1", 99999);

catch err

disp(err.identifier)

disp(err.message)

end

Expected identifier: RunMat:tcpserver:InvalidPort; message explains that port 99999 is outside 0–65535

Example

Create a local listener and inspect its assigned port

srv = tcpserver('127.0.0.1', 0);
assert(srv.ServerPort > 0);
assert(srv.ServerPort <= 65535);
assert(strcmp(srv.ServerAddress, '127.0.0.1'));
close(srv);

Using tcpserver with coding agents

Open a RunMat example with live inputs, then ask the agent to explain how tcpserver changes the result.

Run a small tcpserver example, explain the result, then change one input and compare the output.

FAQ

What range of ports can I use?⌄

Compatible mode accepts the documented range 1 through 65535. RunMat mode also accepts port 0 to request an ephemeral port, reported in ServerPort.

How do I discover which clients are connected?⌄

The returned server value exposes Connected, ClientAddress, and ClientPort. Use accept to wait for an incoming connection and obtain its client value.

Does RunMat support IPv6?⌄

Yes. Pass an IPv6 literal such as "::1" or a hostname resolving to IPv6. ServerAddress reflects the bound address.

Can I change the timeout after creating the server?⌄

Not currently. Set Timeout when creating the server.

Does tcpserver fire callbacks like MATLAB’s BytesAvailableFcn?⌄

No. Callback properties are not active. Use accept, read, and write for explicit handling.

How do I close the server?⌄

Call close(server) to release the listener and its accepted clients.

Can I use GPU arrays for address or port?⌄

Automatically resident inputs gather through their owner. Explicit gpuArray input requires RunMat mode because socket construction is a host operation.

What happens if the port is already in use?⌄

tcpserver raises RunMat:tcpserver:BindFailed with the OS error.

How do I pass additional socket options?⌄

Current support covers Timeout and ByteOrder; RunMat mode also provides legacy Name and UserData. Other socket options are unsupported.

Is TLS supported?⌄

No. tcpserver provides plain TCP sockets only.

Related Io functions

Net

accept · read · readline · tcpclient · write

Repl Fs

addpath · cd · copyfile · delete · dir · exist · fileattrib · fileparts · filesep · fullfile · genpath · getenv · getpref · isenv · isfile · isfolder · ispref · ls · matlabroot · memmapfile · memmapfile.subsasgn · memmapfile.subsref · mkdir · movefile · open · opentoline · path · pathsep · pcode · pwd · readstruct · rehash · restoredefaultpath · rmdir · rmpath · run · savepath · setenv · setpref · system · tempdir · tempname · uigetdir · uigetfile · uiputfile · unsetenv · userpath · what · winqueryreg · xmlread · xmlwrite

Tabular

arrayDatastore · csvread · csvwrite · detectImportOptions · dlmread · dlmwrite · fileDatastore · getvaropts · parquetDatastore · parquetinfo · parquetread · readcell · readmatrix · readtable · readtimetable · setvaropts · setvartype · spreadsheetImportOptions · writecell · writematrix · writetable · writetimetable · xlsread · xlswrite

Audio

audioinfo · audioread

Io

clc · diary · disp · display · format · input

Data

commit · data.copy · data.create · data.delete · data.exists · data.export · data.import · data.inspect · data.list · data.move · data.open · DataArray.chunk_shape · DataArray.codec · DataArray.dtype · DataArray.fill · DataArray.name · DataArray.rank · DataArray.read · DataArray.resize · DataArray.shape · DataArray.write · Dataset.array · Dataset.arrays · Dataset.attrs · Dataset.begin · Dataset.get_attr · Dataset.has_array · Dataset.id · Dataset.path · Dataset.refresh · Dataset.set_attr · Dataset.set_attrs · Dataset.snapshot · Dataset.version · DataTransaction.abort · DataTransaction.commit · DataTransaction.create_array · DataTransaction.delete_array · DataTransaction.fill · DataTransaction.id · DataTransaction.resize · DataTransaction.set_attr · DataTransaction.set_attrs · DataTransaction.status · DataTransaction.write

Filetext

fclose · feof · fgetl · fgets · fileread · filewrite · fopen · fprintf · fread · frewind · fwrite · readlines · writelines

Archive

gunzip · gzip · unzip

Hdf5

h5disp · h5info · h5read · h5write · h5writeatt · hdf5info · hdf5read · hdf5write

Import

importdata · textscan

Json

jsondecode · jsonencode

Mat

load · matfile · matlab.io.MatFile.subsasgn · matlab.io.MatFile.subsref · save

Http

sendmail · urldecode · urlencode · weboptions · webread · websave · webwrite

Source you can read

Every RunMat function's source is public. Read exactly how tcpserver is executed, line by line, in Rust.

  • View the source for tcpserver in Rust on GitHub
  • Learn how the RunMat runtime works
  • Found a bug? Open an issue with a minimal reproduction.

About RunMat

RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.

  • RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
  • Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.

Getting started · Benchmarks · Pricing

Download RunMat

Download RunMat for full performance, or use RunMat in your browser for zero setup.

Download RunMatOpen Sandbox
On this page
  • Syntax
  • Inputs
  • Returns
  • Errors
  • Bind address, port, and options
  • Result, placement, and failures
  • Illustrative programs
  • Example
  • Create a local listener and inspect its assigned port
  • Using tcpserver with coding agents
  • FAQ
  • Related Io functions
  • Net
  • Repl Fs
  • Tabular
  • Audio
  • Io
  • Data
  • Filetext
  • Archive
  • Hdf5
  • Import
  • Json
  • Mat
  • Http
  • Source you can read
  • About RunMat