Package org.yamcs.sle.user

Class RacfServiceUserHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

org.yamcs.sle.user.AbstractServiceUserHandler

org.yamcs.sle.user.RacfServiceUserHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

Direct Known Subclasses:

RafServiceUserHandler, RcfServiceUserHandler

public abstract class RacfServiceUserHandler
extends AbstractServiceUserHandler

Implementation for the CCSDS RECOMMENDED STANDARD FOR SLE RAF SERVICE CCSDS 911.1-B-4 August 2016 https://public.ccsds.org/Pubs/911x1b4.pdf

and

CCSDS 911.1-B-4 August 2016 https://public.ccsds.org/Pubs/911x1b4.pdf

The RAF and RCF service are almost the same but slightly so different (seems like the CCSDS committee was missing from school when the lessons about code reused has been taught).

We do however provide one common RAF/RCF interface to our users highlighting the small differences in the API.

Author:

nm

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class org.yamcs.sle.user.AbstractServiceUserHandler

attr, authLevel, channelHandlerContext, monitors, startingCf, state

Constructor Summary

Constructors

Constructor	Description
RacfServiceUserHandler(Isp1Authentication auth, SleAttributes attr, Constants.DeliveryMode deliveryMode, FrameConsumer consumer)

Method Summary

Modifier and Type	Method	Description
void	addMonitor(RacfSleMonitor monitor)	Add a monitor to be notified when events happen.
Constants.DeliveryMode	getDeliveryMode()
abstract CompletableFuture<SleParameter>	getParameter(int parameterId)	Get the value of an RAF parameter from the provider
void	removeMonitor(RacfSleMonitor monitor)
void	setDeliveryMode(Constants.DeliveryMode deliveryMode)

Methods inherited from class org.yamcs.sle.user.AbstractServiceUserHandler

bind, changeState, channelActive, channelRead, channelRegistered, checkUnbound, exceptionCaught, getApplicationIdentifier, getAuthLevel, getFuture, getInvokeId, getInvokeId, getNonBindCredentials, getState, getVersionNumber, isConnected, notifyDisconnected, peerAbort, processBindInvocation, processData, processStopReturn, processUnbindInvocation, schedulePeriodicStatusReport, setAuthLevel, setVersionNumber, shutdown, stop, stopPeriodicStatusReport, unbind, verifyBindCredentials, verifyNonBindCredentials

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelInactive, channelReadComplete, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

RacfServiceUserHandler

public RacfServiceUserHandler(Isp1Authentication auth,
                              SleAttributes attr,
                              Constants.DeliveryMode deliveryMode,
                              FrameConsumer consumer)

Method Detail

getParameter

public abstract CompletableFuture<SleParameter> getParameter(int parameterId)

Get the value of an RAF parameter from the provider

Specified by:

getParameter in class AbstractServiceUserHandler

Parameters:

parameterId - one of the parameters defined in Constants.ParameterName. Note that not all of them make sense for the RAF, see the table 3-11 in the standard to see which ones make sense.

Returns:

getDeliveryMode

public Constants.DeliveryMode getDeliveryMode()

setDeliveryMode

public void setDeliveryMode(Constants.DeliveryMode deliveryMode)

addMonitor

public void addMonitor(RacfSleMonitor monitor)

Add a monitor to be notified when events happen.

Parameters:

monitor -

removeMonitor

public void removeMonitor(RacfSleMonitor monitor)