rogue
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
rogue::protocols::rssi::Server Class Reference

RSSI server convenience wrapper. More...

#include <Server.h>

Public Member Functions

 Server (uint32_t segSize)
 Constructs an RSSI server bundle.
 
 ~Server ()
 Destroys the server bundle.
 
std::shared_ptr< rogue::protocols::rssi::Transport > transport ()
 Returns the transport endpoint.
 
std::shared_ptr< rogue::protocols::rssi::Application > application ()
 Returns the application endpoint.
 
bool getOpen ()
 Returns whether the link is open.
 
uint32_t getDownCount ()
 Returns the down-transition counter.
 
uint32_t getDropCount ()
 Returns the dropped-frame counter.
 
uint32_t getRetranCount ()
 Returns the retransmit counter.
 
bool getLocBusy ()
 Returns the local busy state.
 
uint32_t getLocBusyCnt ()
 Returns the local busy event counter.
 
bool getRemBusy ()
 Returns the remote busy state.
 
uint32_t getRemBusyCnt ()
 Returns the remote busy event counter.
 
void setLocTryPeriod (uint32_t val)
 Sets the local connection retry period in microseconds.
 
uint32_t getLocTryPeriod ()
 Returns the local connection retry period in microseconds.
 
void setLocMaxBuffers (uint8_t val)
 Sets the local maximum outstanding-buffer count.
 
uint8_t getLocMaxBuffers ()
 Returns the local maximum outstanding-buffer count.
 
void setLocMaxSegment (uint16_t val)
 Sets the local maximum segment size in bytes.
 
uint16_t getLocMaxSegment ()
 Returns the local maximum segment size in bytes.
 
void setLocCumAckTout (uint16_t val)
 Sets the local cumulative-ACK timeout.
 
uint16_t getLocCumAckTout ()
 Returns the local cumulative-ACK timeout.
 
void setLocRetranTout (uint16_t val)
 Sets the local retransmit timeout.
 
uint16_t getLocRetranTout ()
 Returns the local retransmit timeout.
 
void setLocNullTout (uint16_t val)
 Sets the local null-segment timeout.
 
uint16_t getLocNullTout ()
 Returns the local null-segment timeout.
 
void setLocMaxRetran (uint8_t val)
 Sets the local maximum retransmit count.
 
uint8_t getLocMaxRetran ()
 Returns the local maximum retransmit count.
 
void setLocMaxCumAck (uint8_t val)
 Sets the local maximum cumulative-ACK interval.
 
uint8_t getLocMaxCumAck ()
 Returns the local maximum cumulative-ACK interval.
 
uint8_t curMaxBuffers ()
 Returns the negotiated maximum outstanding-buffer count.
 
uint16_t curMaxSegment ()
 Returns the negotiated maximum segment size in bytes.
 
uint16_t curCumAckTout ()
 Returns the negotiated cumulative-ACK timeout.
 
uint16_t curRetranTout ()
 Returns the negotiated retransmit timeout.
 
uint16_t curNullTout ()
 Returns the negotiated null-segment timeout.
 
uint8_t curMaxRetran ()
 Returns the negotiated maximum retransmit count.
 
uint8_t curMaxCumAck ()
 Returns the negotiated maximum cumulative-ACK interval.
 
void resetCounters ()
 Resets runtime counters.
 
void setTimeout (uint32_t timeout)
 Sets timeout in microseconds for frame transmits.
 
void stop ()
 Stops the RSSI connection.
 
void start ()
 Starts or restarts RSSI connection establishment.
 

Static Public Member Functions

static std::shared_ptr< rogue::protocols::rssi::Server > create (uint32_t segSize)
 Creates an RSSI server bundle.
 
static void setup_python ()
 Registers Python bindings for this class.
 

Detailed Description

RSSI server convenience wrapper.

Bundles transport, application, and controller components for server-side RSSI links. Protocol reference: https://confluence.slac.stanford.edu/x/1IyfD

Construction wires the internal components together: Transport <-> Controller <-> Application.

Definition at line 45 of file Server.h.

Constructor & Destructor Documentation

◆ Server()

rogue::protocols::rssi::Server::Server ( uint32_t  segSize)
explicit

Constructs an RSSI server bundle.

Creator.

This constructor is a low-level C++ allocation path. Prefer create() when shared ownership or Python exposure is required.

Parameters
segSizeInitial local maximum segment size.

Definition at line 88 of file Server.cpp.

◆ ~Server()

rogue::protocols::rssi::Server::~Server ( )

Destroys the server bundle.

Destructor.

Definition at line 98 of file Server.cpp.

Member Function Documentation

◆ application()

rogue::protocols::rssi::ApplicationPtr rogue::protocols::rssi::Server::application ( )

Returns the application endpoint.

Application module.

Returns
Shared application interface.

Definition at line 109 of file Server.cpp.

◆ create()

rogue::protocols::rssi::ServerPtr rogue::protocols::rssi::Server::create ( uint32_t  segSize)
static

Creates an RSSI server bundle.

Class creation.

Parameter semantics are identical to the constructor; see Server() for bundle-construction details. This static factory is the preferred construction path when the object is shared across Rogue graph connections or exposed to Python. It returns std::shared_ptr ownership compatible with Rogue pointer typedefs.

Parameters
segSizeInitial local maximum segment size.
Returns
Shared pointer to the created server bundle.

Company : SLAC National Accelerator Laboratory

Description:


This file is part of the rogue software platform. It is subject to the license terms in the LICENSE.txt file found in the top-level directory of this distribution and at: https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. No part of the rogue software platform, including this file, may be copied, modified, propagated, or distributed except according to the terms

contained in the LICENSE.txt file.

Definition at line 38 of file Server.cpp.

◆ curCumAckTout()

uint16_t rogue::protocols::rssi::Server::curCumAckTout ( )

Returns the negotiated cumulative-ACK timeout.

Definition at line 225 of file Server.cpp.

◆ curMaxBuffers()

uint8_t rogue::protocols::rssi::Server::curMaxBuffers ( )

Returns the negotiated maximum outstanding-buffer count.

Definition at line 217 of file Server.cpp.

◆ curMaxCumAck()

uint8_t rogue::protocols::rssi::Server::curMaxCumAck ( )

Returns the negotiated maximum cumulative-ACK interval.

Definition at line 241 of file Server.cpp.

◆ curMaxRetran()

uint8_t rogue::protocols::rssi::Server::curMaxRetran ( )

Returns the negotiated maximum retransmit count.

Definition at line 237 of file Server.cpp.

◆ curMaxSegment()

uint16_t rogue::protocols::rssi::Server::curMaxSegment ( )

Returns the negotiated maximum segment size in bytes.

Definition at line 221 of file Server.cpp.

◆ curNullTout()

uint16_t rogue::protocols::rssi::Server::curNullTout ( )

Returns the negotiated null-segment timeout.

Definition at line 233 of file Server.cpp.

◆ curRetranTout()

uint16_t rogue::protocols::rssi::Server::curRetranTout ( )

Returns the negotiated retransmit timeout.

Definition at line 229 of file Server.cpp.

◆ getDownCount()

uint32_t rogue::protocols::rssi::Server::getDownCount ( )

Returns the down-transition counter.

Get Down Count.

Returns
Number of times the link entered a down/closed state.

Definition at line 119 of file Server.cpp.

◆ getDropCount()

uint32_t rogue::protocols::rssi::Server::getDropCount ( )

Returns the dropped-frame counter.

Get Drop Count.

Returns
Number of dropped received frames.

Definition at line 124 of file Server.cpp.

◆ getLocBusy()

bool rogue::protocols::rssi::Server::getLocBusy ( )

Returns the local busy state.

Get locBusy.

Returns
True when the local endpoint is currently busy.

Definition at line 134 of file Server.cpp.

◆ getLocBusyCnt()

uint32_t rogue::protocols::rssi::Server::getLocBusyCnt ( )

Returns the local busy event counter.

Get locBusyCnt.

Returns
Number of local busy assertions.

Definition at line 139 of file Server.cpp.

◆ getLocCumAckTout()

uint16_t rogue::protocols::rssi::Server::getLocCumAckTout ( )

Returns the local cumulative-ACK timeout.

Definition at line 181 of file Server.cpp.

◆ getLocMaxBuffers()

uint8_t rogue::protocols::rssi::Server::getLocMaxBuffers ( )

Returns the local maximum outstanding-buffer count.

Definition at line 165 of file Server.cpp.

◆ getLocMaxCumAck()

uint8_t rogue::protocols::rssi::Server::getLocMaxCumAck ( )

Returns the local maximum cumulative-ACK interval.

Definition at line 213 of file Server.cpp.

◆ getLocMaxRetran()

uint8_t rogue::protocols::rssi::Server::getLocMaxRetran ( )

Returns the local maximum retransmit count.

Definition at line 205 of file Server.cpp.

◆ getLocMaxSegment()

uint16_t rogue::protocols::rssi::Server::getLocMaxSegment ( )

Returns the local maximum segment size in bytes.

Definition at line 173 of file Server.cpp.

◆ getLocNullTout()

uint16_t rogue::protocols::rssi::Server::getLocNullTout ( )

Returns the local null-segment timeout.

Definition at line 197 of file Server.cpp.

◆ getLocRetranTout()

uint16_t rogue::protocols::rssi::Server::getLocRetranTout ( )

Returns the local retransmit timeout.

Definition at line 189 of file Server.cpp.

◆ getLocTryPeriod()

uint32_t rogue::protocols::rssi::Server::getLocTryPeriod ( )

Returns the local connection retry period in microseconds.

Definition at line 157 of file Server.cpp.

◆ getOpen()

bool rogue::protocols::rssi::Server::getOpen ( )

Returns whether the link is open.

Get state.

Returns
True when the RSSI link is open.

Definition at line 114 of file Server.cpp.

◆ getRemBusy()

bool rogue::protocols::rssi::Server::getRemBusy ( )

Returns the remote busy state.

Get remBusy.

Returns
True when the remote endpoint reports busy.

Definition at line 144 of file Server.cpp.

◆ getRemBusyCnt()

uint32_t rogue::protocols::rssi::Server::getRemBusyCnt ( )

Returns the remote busy event counter.

Get remBusyCnt.

Returns
Number of remote busy indications.

Definition at line 149 of file Server.cpp.

◆ getRetranCount()

uint32_t rogue::protocols::rssi::Server::getRetranCount ( )

Returns the retransmit counter.

Get Retransmit Count.

Returns
Number of retransmitted frames.

Definition at line 129 of file Server.cpp.

◆ resetCounters()

void rogue::protocols::rssi::Server::resetCounters ( )

Resets runtime counters.

Definition at line 245 of file Server.cpp.

◆ setLocCumAckTout()

void rogue::protocols::rssi::Server::setLocCumAckTout ( uint16_t  val)

Sets the local cumulative-ACK timeout.

Definition at line 177 of file Server.cpp.

◆ setLocMaxBuffers()

void rogue::protocols::rssi::Server::setLocMaxBuffers ( uint8_t  val)

Sets the local maximum outstanding-buffer count.

Definition at line 161 of file Server.cpp.

◆ setLocMaxCumAck()

void rogue::protocols::rssi::Server::setLocMaxCumAck ( uint8_t  val)

Sets the local maximum cumulative-ACK interval.

Definition at line 209 of file Server.cpp.

◆ setLocMaxRetran()

void rogue::protocols::rssi::Server::setLocMaxRetran ( uint8_t  val)

Sets the local maximum retransmit count.

Definition at line 201 of file Server.cpp.

◆ setLocMaxSegment()

void rogue::protocols::rssi::Server::setLocMaxSegment ( uint16_t  val)

Sets the local maximum segment size in bytes.

Definition at line 169 of file Server.cpp.

◆ setLocNullTout()

void rogue::protocols::rssi::Server::setLocNullTout ( uint16_t  val)

Sets the local null-segment timeout.

Definition at line 193 of file Server.cpp.

◆ setLocRetranTout()

void rogue::protocols::rssi::Server::setLocRetranTout ( uint16_t  val)

Sets the local retransmit timeout.

Definition at line 185 of file Server.cpp.

◆ setLocTryPeriod()

void rogue::protocols::rssi::Server::setLocTryPeriod ( uint32_t  val)

Sets the local connection retry period in microseconds.

Definition at line 153 of file Server.cpp.

◆ setTimeout()

void rogue::protocols::rssi::Server::setTimeout ( uint32_t  timeout)

Sets timeout in microseconds for frame transmits.

Set timeout for frame transmits in microseconds.

Parameters
timeoutTimeout in microseconds.

Definition at line 250 of file Server.cpp.

◆ setup_python()

void rogue::protocols::rssi::Server::setup_python ( )
static

Registers Python bindings for this class.

Definition at line 43 of file Server.cpp.

◆ start()

void rogue::protocols::rssi::Server::start ( )

Starts or restarts RSSI connection establishment.

Start.

Definition at line 260 of file Server.cpp.

◆ stop()

void rogue::protocols::rssi::Server::stop ( )

Stops the RSSI connection.

Send reset and close.

Definition at line 255 of file Server.cpp.

◆ transport()

rogue::protocols::rssi::TransportPtr rogue::protocols::rssi::Server::transport ( )

Returns the transport endpoint.

Get transport interface.

Returns
Shared transport interface.

Definition at line 104 of file Server.cpp.


The documentation for this class was generated from the following files: