messages

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 3, 2022 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetMessageTypeFromRaw added in v0.3.0

func GetMessageTypeFromRaw(rawMessage string) (int, string, error)

***************************************************************************************

*
* Function : GetMessageTypeFromRaw
*
*  Purpose : Get message type and uniqueid from raw OCPP message
*
*    Input : rawMessage string - raw OCPP message
*
*   Return : string - uniqueID
*            int - message type
*            error when cannot unmarshal message, nil otherwise
*

Types

type CallErrorMessage

type CallErrorMessage struct {
	UniqueID         string
	ErrorCode        string
	ErrorDescription string
	ErrorDetails     map[string]interface{}
}

***************************************************************************************

  • Struct : CallErrorMessage *
  • Purpose : Object handles the Call Error message structure *

****************************************************************************************

func CallErrorMessageConstructor

func CallErrorMessageConstructor() CallErrorMessage

***************************************************************************************

*
* Function : CallErrorMessageConstructor (Constructor)
*
*  Purpose : Creates a new instance of the CallErrorMessage object
*
*	Return : CallErrorMessage

func CallErrorMessageCreator

func CallErrorMessageCreator(rawMessage string) CallErrorMessage

***************************************************************************************

*
* Function : CallErrorMessageCreator (Constructor)
*
*  Purpose : Creates a new instance of the CallErrorMessage object
*
*    Input : rawMessage string - raw message to parse and validate
*
*	 Return : CallErrorMessage

func (*CallErrorMessage) ToString

func (callErrorMessage *CallErrorMessage) ToString() (string, error)

***************************************************************************************

*
* Function : CallErrorMessage::ToString
*
*  Purpose : Convert CallErrorMessage struct to string  message
*
*    Input : Nothing
*
*	 Return : string
*			  error if happened, nil otherwise

type CallMessage

type CallMessage struct {
	UniqueID  string
	Action    string
	Payload   map[string]interface{}
	Signature string
}

***************************************************************************************

  • Struct : CallMessage *
  • Purpose : Object handles the Call message structure *

****************************************************************************************

func CallMessageConstructor

func CallMessageConstructor() CallMessage

***************************************************************************************

*
* Function : CallMessageConstructor (Constructor)
*
*  Purpose : Creates a new instance of the CallMessage object
*
*	Return : CallMessage object

func CreateCallMessage added in v0.3.0

func CreateCallMessage(uniqueID string, action string, payload map[string]interface{}) CallMessage

***************************************************************************************

*
* Function : CallMessage::CreateCallMessage (Constructor)
*
*  Purpose : Creates a new instance of the CallMessage object with provided parameters
*
*	 Return : CallMessage object

func CreateCallMessageCreator

func CreateCallMessageCreator(rawMessage string) CallMessage

***************************************************************************************

*
* Function : CreateCallMessageCreator (Constructor)
*
*  Purpose : Creates a new instance of the CallMessage object using raw message
*
*    Input : rawMessage string - raw message to parse and validate
*
*	 Return : CallMessage object

func (*CallMessage) ToString

func (callMessage *CallMessage) ToString() (string, error)

***************************************************************************************

*
* Function : CallMessage::ToString
*
*  Purpose : Convert CallMessage struct to string  message
*
*	 Return : string
*			  error if happened, nil otherwise

type CallResultMessage

type CallResultMessage struct {
	UniqueID  string
	Payload   map[string]interface{}
	Signature string
}

***************************************************************************************

  • Struct : CallResultMessage *
  • Purpose : Object handles the Call Result message structure *

****************************************************************************************

func CallResultMessageConstructor

func CallResultMessageConstructor() CallResultMessage

func CallResultMessageCreator

func CallResultMessageCreator(rawMessage string) CallResultMessage

***************************************************************************************

*
* Function : CallResultMessageCreator (Constructor)
*
*  Purpose : Creates a new instance of the CallResultMessage from raw message
*
*    Input : rawMessage string - raw message to parse and validate
*
*	 Return : CallResultMessage

func CreateCallResultMessage added in v0.3.0

func CreateCallResultMessage(uniqueID string, payload map[string]interface{}) CallResultMessage

***************************************************************************************

*
* Function : CreateCallResultMessage (Constructor)
*
*  Purpose : Creates a new instance of the CallResultMessage from raw message
*
*    Input : uniqueID string - id to create message
*			  payload map[string]interface{} - payload of the message
*
*	 Return : CallResultMessage

func (*CallResultMessage) ToString

func (callResultMessage *CallResultMessage) ToString() (string, error)

***************************************************************************************

*
* Function : CallResultMessage::ToString
*
*  Purpose : Convert CallResultMessage struct to string  message
*
*    Input : Nothing
*
*	 Return : string
*			  error if happened, nil otherwise

type Message

type Message interface {
	ToString() (string, error)
	// contains filtered or unexported methods
}

***************************************************************************************

  • Interface : Message *
  • Purpose : Interface for Call, CallResult and CallError *

****************************************************************************************

type MessageType

type MessageType int
const (
	MESSAGE_TYPE_CALL MessageType = 2
)
const MESSAGE_TYPE_CALL_ERROR MessageType = 4
const MESSAGE_TYPE_CALL_RESULT MessageType = 3

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL