RspServer(1)

📦
version 3.5.8 · 4 versions
, in ubuntu stonking

💖 RspServer(1) — General Commands Manual ✨

okay bestie, gather round, because this one is a whole menu of services and I need you to stay with me 🫶

🌸 NAME 🌸

rspserver — the RSerPool Server (PE) for multiple example services. yes that's Pool Element energy, and yes she contains multitudes 💅

🎀 SYNOPSIS 🎀

so first up, the general "run it as a pool element" form:

rspserver [-local=address:port,address,...] [-asapannounce=address:port]
          [-identifier=PE_identifier] [-policy=policy_specification]
          [-poolhandle=pool_handle] [-quiet] [-registrar=address:port]
          [-rereginterval=milliseconds] [-runtime=milliseconds]
          [-uptime=seconds] [-downtime=seconds] [-logcolor=on|off]
          [-logappend=filename] [-logfile=filename] [-loglevel=0-9]
          [-cspserver=address:port] [-cspinterval=milliseconds]

then the CalcApp era:

rspserver [-calcapp] [-capcapacity=calculations_per_second]
          [-capcleanshutdownprobability=probability]
          [-capcookiemaxcalculations=calculations]
          [-capcookiemaxtime=seconds]
          [-capkeepalivetransmissioninterval=milliseconds]
          [-capkeepalivetimeoutinterval=milliseconds]
          [-capmaxjobs=max_jobs] [-capobject=name]
          [-capscalar=scalar_file] [-capvector=vector_file]

CharGen mode, obviously:

rspserver [-chargen] [-chargenmaxthreads=threads]

the lil one-liners:

rspserver [-daytime]
rspserver [-discard]
rspserver [-echo]

Fractal (she's giving chaos with failover):

rspserver [-fractal] [-fgpcookiemaxpackets=messages]
          [-fgpcookiemaxtime=milliseconds] [-fgpfailureafter=messages]
          [-fgpmaxthreads=threads] [-fgptestmode]
          [-fgptransmittimeout=milliseconds]

PingPong, the classic:

rspserver [-pingpong] [-pppfailureafter=messages]
          [-pppmaxthreads=threads]

and finally Scripting, aka the powerful one, handle with care:

rspserver [-scripting] [-sskeyring=keyring] [-sstrustdb=trust_db]
          [-sscachedirectory=directory] [-sscachemaxentries=entries]
          [-sscachemaxsize=kibibytes] [-sskeepaliveinterval=milliseconds]
          [-sskeepalivetimeout=milliseconds] [-sskeeptempdirs]
          [-ssmaxthreads=threads] [-sstransmittimeout=milliseconds]

🌈 DESCRIPTION 🌈

okay so rspserver is an example Reliable Server Pooling (RSerPool) pool element (PE) that provides multiple services. here's the tea: on startup you have to pick exactly one service using the command-line parameters. you want more than one running? run multiple instances, bestie. it's giving "buy one get one" except you just start another process 💅

rspserver provides the following services:

  • CalcApp — a calculation application model for performance tests. if you want the receipts (aka more information), the doc lives at https://duepublico.uni-duisburg-essen.de/servlets/DerivateServlet/Derivate-16326/Dre2006_final.pdf.
  • CharGen — sending as much character data as possible. just. so many characters. an absolute flood 🌊
  • Daytime — sending back the current time of day. she's clocking in ⏰
  • Discard — discarding incoming data. no thoughts, head empty, data gone 💀
  • Echo — echoing back incoming data. whatever you say, she says back. mirror behavior fr fr 🪞
  • Fractal — a fractal generator with cookie-based failover 🍪✨
  • PingPong — a simple request-response example using cookies for failover.
  • Scripting — remote execution of scripts, with upload/download of input/output data. could for example be used for distributing simulation runs. Take care of security when using this service! 🚨 like, genuinely, do not skip that part, it's not a vibe, it's a warning ⚠️

to be continued… 🦋 (part 2 incoming, don't go anywhere)

✨ ARGUMENTS ✨

okay bestie, here come the options — all of them, no skips, we're eating the whole plate 🍓

🌸 Common Pool Element Parameters

  • -local=address:port,address,... — sets the local endpoint address(es). yes plural, you can do a whole little list of them 💅
  • -asapannounce=address:port|auto|off — sets the multicast address and port that the ASAP instance listens on for ASAP Server Announces 👀
  • -identifier=PE_identifier — sets a fixed PE identifier. handle with care!! 🚨
  • -policy=policy_specification — sets the pool policy plus its parameters (default is Round Robin). the supported policy specs are:
    • RoundRobin (default policy)
    • WeightedRoundRobin:weight
    • Random
    • WeightedRandom:weight
    • LeastUsed
    • LeastUsedDegradation:increment
    • PriorityLeastUsed:increment
    • LeastUsedDPF:dpf_value
    • Priority:priority
    • ...
  • -poolhandle=pool_handle — sets the PH to a non-default value; otherwise you get the default setting, which is the service-specific default 🎀
  • -quiet — do not print startup and shutdown messages. shhh. silence is golden fr fr 🤫
  • -rereginterval=milliseconds — sets the PE's re-registration interval ⏰
  • -runtime=seconds — after the configured number of seconds, the service is shut down. floating-point values (e.g. 30.125) are possible — yes, decimals, we love precision ✨
  • -uptime=seconds — after negative exponential randomized uptime, the PE service goes down for a configured downtime. after that, it comes up again. this one's for testing the failure handling procedures 🧪
  • -downtime=seconds — after negative exponential randomized downtime, the PE service comes up again. also for testing the failure handling procedures 🧪

💜 Logging Parameters

  • -logappend=filename — write logging output to a file (default is stdout); output will be appended to the given file 📎
  • -logcolor=on|off — turns ANSI colorization of the logging output on or off 🌈
  • -logfile=filename — write logging output to a file (default is stdout); the given file will be overwritten ⚠️ (yes, overwritten, not appended, be careful bestie)
  • -loglevel=0-9 — sets the logging verbosity from 0 (none) to 9 (very verbose). it is recommended to use at least a value of 2 to see possibly important error messages and warnings 🔍

🦋 ASAP Protocol Parameters

  • -registrar=address:port — adds a static PR entry into the Registrar Table. it is possible to add multiple entries 👑
  • -registrarannouncetimeout=milliseconds — sets the timeout for ASAP announces via multicast 📡
  • -registrarconnecttimeout=milliseconds — sets the timeout for ASAP connection establishment 🤝
  • -registrarconnectmaxtrials=trials — sets the maximum number of ASAP connection establishment trials 🔁
  • -registrarrequesttimeout=milliseconds — sets the timeout for ASAP requests ⏳
  • -registrarresponsetimeout=milliseconds — sets the timeout for waiting to receive ASAP responses 📬
  • -registrarrequestmaxtrials=trials — sets the maximum number of ASAP request trials 🔁

🎀 Component Status Protocol (CSP) Parameters

  • -cspinterval=milliseconds — sets the interval for the CSP status updates in milliseconds. by default, the content of the environment variable CSP_INTERVAL is used. if not defined, no CSP status reports will be sent 🙈
  • -cspserver=address:port — sets the address of a CSP monitor server. by default, the content of the environment variable CSP_SERVER is used. if not defined, no CSP status reports will be sent 🙈

🔥 Service Parameters

  • -calcapp — starts the CalcApp service 🧮
    • -capcapacity=calculations_per_second — sets the service capacity in calculations per second ⚡
    • -capcleanshutdownprobability=probability — sets the probability for sending state cookies to all sessions before shutting down 🍪
    • -capcookiemaxcalculations=calculations — sets the cookie interval in calculations 🍪
    • -capcookiemaxtime=seconds — sets the cookie interval in seconds 🍪
    • -capkeepalivetransmissioninterval=milliseconds — sets the keep-alive transmission interval in milliseconds 💓
    • -capkeepalivetimeoutinterval=milliseconds — sets the keep-alive timeout in milliseconds 💓
    • -capmaxjobs=max_jobs — sets an upper limit for the number of simultaneous CalcApp requests 🚧
    • -capobject=name — sets the object name for scalar hierarchy 🏷️
    • -capscalar=scalar_file — sets the name of vector scalar file to write ✍️
    • -capvector=vector_file — sets the name of vector output file to write ✍️
  • -chargen — starts the CharGen service 🔤
    • -chargenmaxthreads=threads — sets an upper limit for the number of simultaneous CharGen sessions 🚧
  • -daytime — starts the Daytime service ☀️
  • -discard — starts the Discard service 🗑️
  • -echo — starts the Echo service 📣
  • -fractal — starts the Fractal Generator service 🌀
    • -fgpcookiemaxpackets=messages — send cookie after the given number of Data messages 🍪
    • -fgpcookiemaxtime=milliseconds — send cookie after the given number of milliseconds 🍪
    • -fgpfailureafter=messages — after the set number of data packets, the server will terminate the connection in order to test failovers 💀
    • -fgpmaxthreads=threads — sets an upper limit for the number of simultaneous Fractal Generator sessions 🚧
    • -fgptestmode — generate a simple test pattern instead of calculating a fractal graphics (useful to conserve CPU power when debugging) 🔋
    • -fgptransmittimeout=milliseconds — sets transmit timeout in milliseconds ⏳
  • -pingpong — starts the PingPong service 🏓
    • -pppfailureafter=messages — after the set number of messages, the server will terminate the connection in order to test failovers 💀
    • -pppmaxthreads=threads — sets an upper limit for the number of simultaneous PingPong sessions 🚧
  • -scripting — starts the Scripting service 📜
    • -sskeyring=keyring — the location of a GnuPG keyring to check the work packages and environments against. if a keyring is specified, only files that pass the validation are accepted 🔐
    • -sscachedirectory=directory — sets the environment cache directory 📁
    • -sscachemaxentries=entries — sets the maximum number of environment cache entries 🔢
    • -sscachemaxsize=kibibytes — sets the maximum size of the environment cache in kibibytes 📦
    • -sskeepaliveinterval=milliseconds — sets the keep-alive interval in milliseconds 💓
    • -sskeepalivetimeout=milliseconds — sets the keep-alive timeout in milliseconds 💓
    • -sskeeptempdirs — turns on keeping all temporary files for debugging. handle with care!! 🚨
    • -ssmaxthreads=threads — sets an upper limit for the number of simultaneous sessions 🚧
    • -sstransmittimeout=milliseconds — sets the transmission timeout in milliseconds ⏳

🌈 ENVIRONMENT

rspserver uses the environment variables CSP_SERVER and CSP_INTERVAL to define a CSP server to send reports to, in the specified interval. so basically: env vars in, status reports out 💌

⭐ DIAGNOSTICS

if loglevel>0, log messages will be printed to stdout or into a specified log file. turn it up and watch the tea spill 🫖

💖 SEE ALSO

for a detailed introduction to RSerPool, see:

https://duepublico.uni-duisburg-essen.de/servlets/DerivateServlet/Derivate-16326/Dre2006_final.pdf

Thomas Dreibholz's RSerPool Page:

https://www.nntb.no/~dreibh/rserpool/

okay bestie that's the whole page, you made it, icon behavior honestly 👑💅 this one's from RSerPool Server, edition September 19, 2025, and it lives in section RspServer(1) — go forth and configure something iconic, no cap 🦋✨

📦 where this page comes from