|
rogue
|
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. | |
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.
|
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.
| segSize | Initial local maximum segment size. |
Definition at line 88 of file Server.cpp.
| rogue::protocols::rssi::Server::~Server | ( | ) |
| rogue::protocols::rssi::ApplicationPtr rogue::protocols::rssi::Server::application | ( | ) |
Returns the application endpoint.
Application module.
Definition at line 109 of file Server.cpp.
|
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.
| segSize | Initial local maximum segment size. |
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
Definition at line 38 of file Server.cpp.
| uint16_t rogue::protocols::rssi::Server::curCumAckTout | ( | ) |
Returns the negotiated cumulative-ACK timeout.
Definition at line 225 of file Server.cpp.
| uint8_t rogue::protocols::rssi::Server::curMaxBuffers | ( | ) |
Returns the negotiated maximum outstanding-buffer count.
Definition at line 217 of file Server.cpp.
| uint8_t rogue::protocols::rssi::Server::curMaxCumAck | ( | ) |
Returns the negotiated maximum cumulative-ACK interval.
Definition at line 241 of file Server.cpp.
| uint8_t rogue::protocols::rssi::Server::curMaxRetran | ( | ) |
Returns the negotiated maximum retransmit count.
Definition at line 237 of file Server.cpp.
| uint16_t rogue::protocols::rssi::Server::curMaxSegment | ( | ) |
Returns the negotiated maximum segment size in bytes.
Definition at line 221 of file Server.cpp.
| uint16_t rogue::protocols::rssi::Server::curNullTout | ( | ) |
Returns the negotiated null-segment timeout.
Definition at line 233 of file Server.cpp.
| uint16_t rogue::protocols::rssi::Server::curRetranTout | ( | ) |
Returns the negotiated retransmit timeout.
Definition at line 229 of file Server.cpp.
| uint32_t rogue::protocols::rssi::Server::getDownCount | ( | ) |
Returns the down-transition counter.
Get Down Count.
Definition at line 119 of file Server.cpp.
| uint32_t rogue::protocols::rssi::Server::getDropCount | ( | ) |
Returns the dropped-frame counter.
Get Drop Count.
Definition at line 124 of file Server.cpp.
| bool rogue::protocols::rssi::Server::getLocBusy | ( | ) |
Returns the local busy state.
Get locBusy.
Definition at line 134 of file Server.cpp.
| uint32_t rogue::protocols::rssi::Server::getLocBusyCnt | ( | ) |
Returns the local busy event counter.
Get locBusyCnt.
Definition at line 139 of file Server.cpp.
| uint16_t rogue::protocols::rssi::Server::getLocCumAckTout | ( | ) |
Returns the local cumulative-ACK timeout.
Definition at line 181 of file Server.cpp.
| uint8_t rogue::protocols::rssi::Server::getLocMaxBuffers | ( | ) |
Returns the local maximum outstanding-buffer count.
Definition at line 165 of file Server.cpp.
| uint8_t rogue::protocols::rssi::Server::getLocMaxCumAck | ( | ) |
Returns the local maximum cumulative-ACK interval.
Definition at line 213 of file Server.cpp.
| uint8_t rogue::protocols::rssi::Server::getLocMaxRetran | ( | ) |
Returns the local maximum retransmit count.
Definition at line 205 of file Server.cpp.
| uint16_t rogue::protocols::rssi::Server::getLocMaxSegment | ( | ) |
Returns the local maximum segment size in bytes.
Definition at line 173 of file Server.cpp.
| uint16_t rogue::protocols::rssi::Server::getLocNullTout | ( | ) |
Returns the local null-segment timeout.
Definition at line 197 of file Server.cpp.
| uint16_t rogue::protocols::rssi::Server::getLocRetranTout | ( | ) |
Returns the local retransmit timeout.
Definition at line 189 of file Server.cpp.
| uint32_t rogue::protocols::rssi::Server::getLocTryPeriod | ( | ) |
Returns the local connection retry period in microseconds.
Definition at line 157 of file Server.cpp.
| bool rogue::protocols::rssi::Server::getOpen | ( | ) |
Returns whether the link is open.
Get state.
Definition at line 114 of file Server.cpp.
| bool rogue::protocols::rssi::Server::getRemBusy | ( | ) |
Returns the remote busy state.
Get remBusy.
Definition at line 144 of file Server.cpp.
| uint32_t rogue::protocols::rssi::Server::getRemBusyCnt | ( | ) |
Returns the remote busy event counter.
Get remBusyCnt.
Definition at line 149 of file Server.cpp.
| uint32_t rogue::protocols::rssi::Server::getRetranCount | ( | ) |
Returns the retransmit counter.
Get Retransmit Count.
Definition at line 129 of file Server.cpp.
| void rogue::protocols::rssi::Server::resetCounters | ( | ) |
Resets runtime counters.
Definition at line 245 of file Server.cpp.
| void rogue::protocols::rssi::Server::setLocCumAckTout | ( | uint16_t | val | ) |
Sets the local cumulative-ACK timeout.
Definition at line 177 of file Server.cpp.
| void rogue::protocols::rssi::Server::setLocMaxBuffers | ( | uint8_t | val | ) |
Sets the local maximum outstanding-buffer count.
Definition at line 161 of file Server.cpp.
| void rogue::protocols::rssi::Server::setLocMaxCumAck | ( | uint8_t | val | ) |
Sets the local maximum cumulative-ACK interval.
Definition at line 209 of file Server.cpp.
| void rogue::protocols::rssi::Server::setLocMaxRetran | ( | uint8_t | val | ) |
Sets the local maximum retransmit count.
Definition at line 201 of file Server.cpp.
| 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.
| void rogue::protocols::rssi::Server::setLocNullTout | ( | uint16_t | val | ) |
Sets the local null-segment timeout.
Definition at line 193 of file Server.cpp.
| void rogue::protocols::rssi::Server::setLocRetranTout | ( | uint16_t | val | ) |
Sets the local retransmit timeout.
Definition at line 185 of file Server.cpp.
| 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.
| void rogue::protocols::rssi::Server::setTimeout | ( | uint32_t | timeout | ) |
Sets timeout in microseconds for frame transmits.
Set timeout for frame transmits in microseconds.
| timeout | Timeout in microseconds. |
Definition at line 250 of file Server.cpp.
|
static |
Registers Python bindings for this class.
Definition at line 43 of file Server.cpp.
| void rogue::protocols::rssi::Server::start | ( | ) |
| void rogue::protocols::rssi::Server::stop | ( | ) |
| rogue::protocols::rssi::TransportPtr rogue::protocols::rssi::Server::transport | ( | ) |
Returns the transport endpoint.
Get transport interface.
Definition at line 104 of file Server.cpp.