mdsinteractor

Documentation

Overview

Package mdsinteractor will be responsible for communicating with MDS

Index

• Constants
• func New(context context.T, msgHandler messageHandler.IMessageHandler, ...) (interactor.IInteractor, error)
• type MDSInteractor
  • func (mds *MDSInteractor) Close() error
  • func (mds *MDSInteractor) GetName() string
  • func (mds *MDSInteractor) GetSupportedWorkers() []utils.WorkerName
  • func (mds *MDSInteractor) Initialize(ableToOpenMGSConnection *uint32) (err error)
  • func (mds *MDSInteractor) PostProcessorInitialization(worker utils.WorkerName)
  • func (mds *MDSInteractor) PreProcessorClose()
• type MDSState

Constants

const (
	// Name of the interactor, to register to message service
	Name = "MDSInteractor"
)

Functions

func New

func New(context context.T, msgHandler messageHandler.IMessageHandler, service mdsService.Service) (interactor.IInteractor, error)

New initiates and returns MDS Interactor when needed

Types

type MDSInteractor

type MDSInteractor struct {
	// contains filtered or unexported fields
}

MDSInteractor defines the properties and methods to communicate with MDS

func (*MDSInteractor) Close

func (mds *MDSInteractor) Close() error

Close closes connection. The closing operations for MDS interactor is done in BeforeClose itself. Hence, this function does not operation now.

func (*MDSInteractor) GetName

func (mds *MDSInteractor) GetName() string

GetName used to get the name of interactor

func (*MDSInteractor) GetSupportedWorkers

func (mds *MDSInteractor) GetSupportedWorkers() []utils.WorkerName

GetSupportedWorkers returns the workers needed by the interactors

func (*MDSInteractor) Initialize

func (mds *MDSInteractor) Initialize(ableToOpenMGSConnection *uint32) (err error)

Initialize initializes MDSInteractor properties and starts failed reply job

func (*MDSInteractor) PostProcessorInitialization

func (mds *MDSInteractor) PostProcessorInitialization(worker utils.WorkerName)

PostProcessorInitialization registers executes PostProcessorInitialization operations Will be executed after the processor initialization is done in MessageService Currently we use this only for command processors/document worker

func (*MDSInteractor) PreProcessorClose

func (mds *MDSInteractor) PreProcessorClose()

PreProcessorClose defines operations to be performed before processor close Before command worker processor close, we try to close the message polling and send failed reply job in this function

type MDSState

type MDSState string

const (
	MDSStartInProgress MDSState = "MDSStartInProgress"
	MDSStartCompleted  MDSState = "MDSStartCompleted"
	MDSStopInProgress  MDSState = "MDSStopInProgress"
	MDSStopCompleted   MDSState = "MDSStopCompleted"
	MDSShutDown        MDSState = "MDSShutDown"
)