WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

ChannelObject
✖
ChannelObject

[Experimental]

ChannelObject[]

gives a new anonymous channel specification.

ChannelObject["mqtts://…"]

represents a channel specified by a given URL.

ChannelObject["relpath"]

represents a channel for the currently authenticated user at a relative path.

ChannelObject["id:path"]

represents a channel for the user with the specified Wolfram ID at the given path.

ChannelObject["/abspath"]

represents a channel at an absolute path on the channel broker.

Details and Options

Examples

open allclose all

Basic Examples  (2)Summary of the most common use cases

A new anonymous channel:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-fwp8pl
Out[1]=1

A named channel of the currently authenticated user:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-r90h7i
Out[1]=1

Scope  (8)Survey of the scope of standard use cases

A new unnamed channel:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-nz7rcz
Out[1]=1

A channel in the home area of the currently authenticated user:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-k20ph8
Out[1]=1

A named channel in a subdirectory of the home area:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-dyx6uc
Out[1]=1

A named channel of another user:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-61tnzz
Out[1]=1

A channel referred to by the absolute path on the channel broker server:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-xxgpxk
Out[1]=1

A channel referred to by the URL:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-w962lp
Out[1]=1

A channel associated with a cloud object deployed for a channel receiver:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-etpmja
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dqukuqt3yq-hfcvdv
Out[2]=2

Delete the channel that was automatically created by CloudDeploy:

In[3]:=3
✖
https://wolfram.com/xid/0dqukuqt3yq-9pdb8q

A channel with options:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-fcyzdc
Out[1]=1

Options  (2)Common values & functionality for each option

Permissions  (2)

Create a public channel:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-obiafz
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dqukuqt3yq-f66tuu
Out[2]=2

Start listening on the channel and send some data:

In[3]:=3
✖
https://wolfram.com/xid/0dqukuqt3yq-51mhbp
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0dqukuqt3yq-tmg9yz

The received message:

In[5]:=5
✖
https://wolfram.com/xid/0dqukuqt3yq-rsxm1n
Out[5]=5

Other users can send data to your channel by referring to your $WolframID:

In[6]:=6
✖
https://wolfram.com/xid/0dqukuqt3yq-c0h6nd
Out[6]=6
In[7]:=7
✖
https://wolfram.com/xid/0dqukuqt3yq-mx75hd

Clean up:

In[8]:=8
✖
https://wolfram.com/xid/0dqukuqt3yq-04sax1

A channel to which you can listen and everyone can send messages:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-7mzyqi
Out[1]=1

Properties & Relations  (4)Properties of the function, and connections to other functions

ChannelObject creates a reference to the channel without creating a channel on the server:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-44d0en
Out[1]=1

Check that the channel does not exist:

In[2]:=2
✖
https://wolfram.com/xid/0dqukuqt3yq-s13ea2
Out[2]=2

Create a channel and verify that it exists on the server:

In[3]:=3
✖
https://wolfram.com/xid/0dqukuqt3yq-e7cbsb
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0dqukuqt3yq-0y4jpt
Out[4]=4

Delete the channel from the server:

In[5]:=5
✖
https://wolfram.com/xid/0dqukuqt3yq-62v7l7
Out[5]=5

CreateChannel returns a ChannelObject:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-5w6n2x
Out[1]=1

Clean up:

In[2]:=2
✖
https://wolfram.com/xid/0dqukuqt3yq-libedg

ChannelObject is used by ChannelListen, ChannelSend, and other functions:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-6hiwiu
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dqukuqt3yq-4h8avm
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0dqukuqt3yq-fiw72k
In[4]:=4
✖
https://wolfram.com/xid/0dqukuqt3yq-00oyft
Out[4]=4

ChannelObject can be retrieved from the ChannelListener object:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-9bjptj
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0dqukuqt3yq-kxn5rn
Out[2]=2

Clean up:

In[3]:=3
✖
https://wolfram.com/xid/0dqukuqt3yq-pdvgyj

Possible Issues  (1)Common pitfalls and unexpected behavior

Non-alphanumeric characters are generally not allowed in channel names:

In[1]:=1
✖
https://wolfram.com/xid/0dqukuqt3yq-owu331
Out[1]=1

Hyphen characters are allowed:

In[2]:=2
✖
https://wolfram.com/xid/0dqukuqt3yq-lpqv61
Out[2]=2
Wolfram Research (2016), ChannelObject, Wolfram Language function, https://reference.wolfram.com/language/ref/ChannelObject.html (updated 2017).
✖
Wolfram Research (2016), ChannelObject, Wolfram Language function, https://reference.wolfram.com/language/ref/ChannelObject.html (updated 2017).

Text

Wolfram Research (2016), ChannelObject, Wolfram Language function, https://reference.wolfram.com/language/ref/ChannelObject.html (updated 2017).

✖
Wolfram Research (2016), ChannelObject, Wolfram Language function, https://reference.wolfram.com/language/ref/ChannelObject.html (updated 2017).

CMS

Wolfram Language. 2016. "ChannelObject." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2017. https://reference.wolfram.com/language/ref/ChannelObject.html.

✖
Wolfram Language. 2016. "ChannelObject." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2017. https://reference.wolfram.com/language/ref/ChannelObject.html.

APA

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

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

BibTeX

@misc{reference.wolfram_2025_channelobject, author="Wolfram Research", title="{ChannelObject}", year="2017", howpublished="\url{https://reference.wolfram.com/language/ref/ChannelObject.html}", note=[Accessed: 19-June-2025 ]}

✖
@misc{reference.wolfram_2025_channelobject, author="Wolfram Research", title="{ChannelObject}", year="2017", howpublished="\url{https://reference.wolfram.com/language/ref/ChannelObject.html}", note=[Accessed: 19-June-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_channelobject, organization={Wolfram Research}, title={ChannelObject}, year={2017}, url={https://reference.wolfram.com/language/ref/ChannelObject.html}, note=[Accessed: 19-June-2025 ]}

✖
@online{reference.wolfram_2025_channelobject, organization={Wolfram Research}, title={ChannelObject}, year={2017}, url={https://reference.wolfram.com/language/ref/ChannelObject.html}, note=[Accessed: 19-June-2025 ]}