Rerun C++ SDK
Loading...
Searching...
No Matches
rerun::GrpcSink Struct Reference

Log sink which streams messages to an existing Rerun gRPC server. More...

#include <rerun/log_sink.hpp>

Public Member Functions

 operator LogSink () const
 

Public Attributes

std::string_view url = "rerun+http://127.0.0.1:9876/proxy"
 A Rerun gRPC URL.
 
std::chrono::duration< float > flush_timeout = std::chrono::seconds(5)
 How long a flush waits for the connection to be established.
 

Detailed Description

Log sink which streams messages to an existing Rerun gRPC server.

This is a gRPC client: it connects to a server but does not host one. Use GrpcServerSink to host a server that SDKs and Viewers can connect to.

The behavior of this sink is the same as the one set by RecordingStream::connect_grpc.

Member Data Documentation

◆ url

std::string_view rerun::GrpcSink::url = "rerun+http://127.0.0.1:9876/proxy"

A Rerun gRPC URL.

The scheme must be one of rerun://, rerun+http://, or rerun+https://, and the pathname must be /proxy.

The default is rerun+http://127.0.0.1:9876/proxy.

◆ flush_timeout

std::chrono::duration<float> rerun::GrpcSink::flush_timeout = std::chrono::seconds(5)

How long a flush waits for the connection to be established.

If the sink has not connected by then, the flush fails, and dropping the sink discards the data that has not been sent. Must be finite and non-negative.


The documentation for this struct was generated from the following file: