Event Hubs

Receive client events from the PowerShell Universal server.
Event Hubs provide the ability to connect client to the PowerShell Universal server. Once connected, the PowerShell Universal server can send messages to the connected clients and they will run a local PowerShell script block.

Creating an Event Hub

To create an event hub, click APIs \ Event Hub and click Create New Event Hub. Event Hubs are named and can choose to enforce authentication and authorization.

Connecting an Event Hub

Once created, clients can connect to an event hub using the Connect-PSUEventHub cmdlet found in the Universal module. The cmdlet connects to the hub using a web socket and provides credentials, if necessary. When connecting, specify the -ScriptBlock parameter to define what will happen on the client when an event is received.
Connect-PSUEventHub -ComputerName http://localhost:5000 -Hub 'MyHub' -ScriptBlock {
Write-Host "Event Received"
Objects sent from the hub will be available as $_ or $PSItem.
Connect-PSUEventHub -ComputerName http://localhost:5000 -Hub 'MyHub' -ScriptBlock {
Write-Host $_

Send Events

From within the PowerShell Universal server, you can send events from a hub to connected clients using the Send-PSUEvent cmdlet.
Send-PSUEvent -Hub 'MyHub' -Data "Hello!"
The -Data parameter accepts an object and will be serialized using CLIXML and send to the client. The data will be deserialized before passing to the script block.

Receive Data from Clients

As of 4.1, you can now receive data back from clients. This feature is only available when sending data to an individual client, rather than all clients connected to a hub.
$Connection = Get-PSUEventHubConnection | Where-Object UserName -eq 'Admin'
$Result = Send-PSUEvent -Hub 'Hub' -Data 'Say Hello!' -Connectionid $Connection.ConnectionId
Show-UDToast $Result
From the client side, you would return the data from the script block.
Connect-PSUEventHub -Hub 'Hub' -ScriptBlock {
Write-Host $EventData

View Connected Clients

Within the PowerShell Universal server, you can view connected clients by clicking APIs \ Event Hubs and then clicking the Connections tab.
Copyright 2022 Ironman Software