Preview documentation

This page has not completed release review. Its SDK or protocol version is not yet a confirmed public release.

GameLink Polling¶

Release verification required

This example is pinned to commit 16c6b9796ae02105153ac33482d83ac609398d2e. Publish and confirm a supported GameLink release before approving this page for production.

This recipe assumes you have authenticated a gamelink::SDK, connected its payload queue to a WebSocket, and saved the returned refresh token.

Register the update handler¶

auto onPollUpdate = [](const gamelink::schema::PollUpdateResponse& response) {
    const auto& poll = response.data.poll;
    std::cout << poll.prompt << "\n";

    for (std::size_t index = 0; index < poll.options.size(); ++index) {
        const int votes = index < response.data.results.size()
            ? response.data.results[index]
            : 0;
        std::cout << poll.options[index] << ": " << votes << "\n";
    }
};

gamelink::PollConfiguration configuration;
sdk.RunPoll(
    "favorite-character",
    "Who is your favorite character?",
    configuration,
    {"Ada", "Grace", "Margaret"},
    onPollUpdate,
    onPollUpdate
);

Poll IDs are scoped to the current channel. Use a stable, URL-safe identifier and no more than 10 options; the SDK enforces that limit before queuing the request.

Pump network traffic¶

Every game tick, send queued SDK payloads and pass received WebSocket frames back to the SDK:

sdk.ForeachPayload([&](const gamelink::Payload* payload) {
    websocket.send(payload->Data(), payload->Length());
});

websocket.run();

Stop or delete polls when they are no longer active. See GameLink polling protocol for the canonical wire messages.

GameLink Polling¶

Register the update handler¶

Create and subscribe to a poll¶

Pump network traffic¶