WOLFRAM

Wolfram Language & System Documentation Center

SocketObject[…]

represents a network socket connection.

Details
Details and Options Details and Options
Examples  
Basic Examples  
See Also
Related Guides
History
Cite this Page

SocketObject

SocketObject[…]

represents a network socket connection.

Details

  • Both SocketConnect and SocketOpen give SocketObject[…].
  • Functions that operate on socket connections specified by SocketObject include Read, Write, ReadString, WriteString, BinaryRead and BinaryWrite.
  • Socket connections are closed using Close.
  • SocketConnect creates a socket connection from a source address to a destination address.
  • SocketOpen opens a socket at a destination address that accepts connections from source addresses.
  • Properties of a socket connection can be found using SocketObject[…][prop] or Options[SocketObject[…],prop]. When applicable, options can be set using SetOptions.
  • Properties for all connections include:
  • "SourceIPAddress"the complete source IP address
    "SourcePort"the source port number (as an integer)
    "DestinationIPAddress"the complete destination IP address
    "DestinationPort"the destination port number (as an integer)
    "Protocol"the connection protocol used ("TCP", "ZMQ", ...)
    "UUID"the asociated UUID for the socket
  • Properties of web socket connections also include:
  • "Connected"whether the connection is still alive
    "ConnectionClosedCode"the status code provided when the connection was closed, if any
    "ConnectionClosedReason"the reason provided when the connection was closed, if any
    "SocketListener"the relevant SocketListener, if installed

Examples

Basic Examples  (3)

Open a connection to a server specified by a URL:

Wolfram Language code: socket = SocketConnect["http://exampledata.wolfram.com"]

Write to the socket:

Wolfram Language code: WriteString[socket, "GET / HTTP/1.0 "]

Read the first line of the response:

Wolfram Language code: Snippet[ReadLine[socket]]

Close the socket connection:

Wolfram Language code: Close[socket]

Connect to a server:

Wolfram Language code: socket = SocketConnect["http://wolfram.com"]

Get the outgoing "SourceIPAddress" on your machine for this socket:

Wolfram Language code: socket["SourceIPAddress"]

Close the socket:

Wolfram Language code: Close[socket]

Open a "ZMQ" socket to listen on and connect a client to it:

Wolfram Language code: server = SocketOpen[Automatic, "ZMQ"]; client = SocketConnect[server]

The default "Type" for "ZMQ" sockets is "ZMQ_PAIR":

Wolfram Language code: client["Type"]

Close the socket:

Wolfram Language code: Close /@ {server, client}
Wolfram Research (2015), SocketObject, Wolfram Language function, https://reference.wolfram.com/language/ref/SocketObject.html (updated 2026).

Text

Wolfram Research (2015), SocketObject, Wolfram Language function, https://reference.wolfram.com/language/ref/SocketObject.html (updated 2026).

CMS

Wolfram Language. 2015. "SocketObject." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2026. https://reference.wolfram.com/language/ref/SocketObject.html.

APA

Wolfram Language. (2015). SocketObject. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/SocketObject.html

BibTeX

@misc{reference.wolfram_2026_socketobject, author="Wolfram Research", title="{SocketObject}", year="2026", howpublished="\url{https://reference.wolfram.com/language/ref/SocketObject.html}", note=[Accessed: 13-June-2026]}

BibLaTeX

@online{reference.wolfram_2026_socketobject, organization={Wolfram Research}, title={SocketObject}, year={2026}, url={https://reference.wolfram.com/language/ref/SocketObject.html}, note=[Accessed: 13-June-2026]}