Whatever message this page gives is out now! Go check it out!

WSPublish

Last update:
May 18, 2026

Description

Sends messages to a specific channel based on the filter criteria (which is a struct).

Category

History

ColdFusion 11: Added the parameter clustered
ColdFusion 10: Added this function

Syntax

WSPublish(channel,message,[filterCriteria="",clustered=false])

Parameters

Parameter
Description
channel
Specific channel to which the server publishes its response.
message
Response sent by the server to all clients subscribed to a specific channel.
filterCriteria
Conditions to filter eligible clients that need to be notified for a given channel.
clustered
If true, fetches subscriber information from all configured nodes.

Example

<cfscript> 
if(isdefined("form.publish")) 
WsPublish(#form.channel#, #form.message#); 
</cfscript> 
<cfform method="post"> 
<cfselect name="channel"> 
<option> 
stocks 
</option> 
<option> 
news 
</option> 
<option> 
products 
</option> 
</cfselect> 
Message: 
<input id="message" name="message" type="text"> 
<cfinput id="publish" name="publish" value="publish" type="submit"> 
</cfform>

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page