events

Documentation

Index

• Constants
• Variables
• func CalculateEventSignature(secret, contentType string, eventType EventType, subscriptionID string, ...) string
• type Device
• type DevicesOffline
• type DevicesOnline
• type DevicesRegistered
• type DevicesUnregistered
• type EventHeader
  • func ParseEventHeader(r *http.Request) (h EventHeader, _ error)
  • func (h EventHeader) GetContentDecoder() (func(w []byte, v interface{}) error, error)
• type EventType
• type EventTypes
  • func (e EventTypes) Has(ev EventType) bool
• type ResourceChanged
• type ResourcesPublished
• type ResourcesUnpublished
• type SubscriptionRequest
• type SubscriptionResponse

Constants

const (
	CorrelationIDKey  = "Correlation-ID"
	SubscriptionIDKey = "Subscription-ID"
	ContentTypeKey    = "Content-Type"
	AcceptKey         = "Accept"
	EventTypeKey      = "Event-Type"
	SequenceNumberKey = "Sequence-Number"
	EventTimestampKey = "Event-Timestamp"
	EventSignatureKey = "Event-Signature"
	AcceptEncodingKey = "Accept-Encoding"
)

https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.r.cloudapiforcloudservices.swagger.json

const ContentEncodingKey = "Content-Encoding"

Variables

var (
	ContentType_JSON       = message.AppJSON.String()
	ContentType_VNDOCFCBOR = message.AppOcfCbor.String()
)

var (
	AllDevicesEvents  = []EventType{EventType_DevicesOnline, EventType_DevicesOffline, EventType_DevicesRegistered, EventType_DevicesUnregistered}
	AllDeviceEvents   = []EventType{EventType_ResourcesPublished, EventType_ResourcesUnpublished}
	AllResourceEvents = []EventType{EventType_ResourceChanged}
)

Functions

func CalculateEventSignature

func CalculateEventSignature(secret, contentType string, eventType EventType, subscriptionID string, seqNum uint64, timeStamp time.Time, body []byte) string

Types

type Device

type Device struct {
	ID string `json:"di"`
}

type DevicesOffline

type DevicesOffline []Device

https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.r.cloudapiforcloudservices.swagger.json#/definitions/DevicesOfflineEvent

type DevicesOnline

type DevicesOnline []Device

https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.r.cloudapiforcloudservices.swagger.json#/definitions/DevicesOnlineEvent

type DevicesRegistered

type DevicesRegistered []Device

https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.r.cloudapiforcloudservices.swagger.json#/definitions/DevicesRegisteredEvent

type DevicesUnregistered

type DevicesUnregistered []Device

https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.r.cloudapiforcloudservices.swagger.json#/definitions/DevicesUnregisteredEvent

type EventHeader

type EventHeader struct {
	CorrelationID   string
	ID              string
	ContentType     string
	EventType       EventType
	SequenceNumber  uint64
	EventTimestamp  time.Time
	EventSignature  string
	AcceptEncoding  []string
	ContentEncoding string
}

func ParseEventHeader

func ParseEventHeader(r *http.Request) (h EventHeader, _ error)

func (EventHeader) GetContentDecoder

func (h EventHeader) GetContentDecoder() (func(w []byte, v interface{}) error, error)

type EventType

type EventType string

const (
	// resource
	EventType_ResourceChanged EventType = "resource_contentchanged"

	// device
	EventType_ResourcesPublished   EventType = "resources_published"
	EventType_ResourcesUnpublished EventType = "resources_unpublished"

	// devices
	EventType_DevicesOnline       EventType = "devices_online"
	EventType_DevicesOffline      EventType = "devices_offline"
	EventType_DevicesRegistered   EventType = "devices_registered"
	EventType_DevicesUnregistered EventType = "devices_unregistered"

	// among all
	EventType_SubscriptionCanceled EventType = "subscription_cancelled"
)

https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.r.cloudapiforcloudservices.swagger.json#/definitions/EventType

type EventTypes

type EventTypes []EventType

func (EventTypes) Has

func (e EventTypes) Has(ev EventType) bool

type ResourceChanged

type ResourceChanged []byte

type ResourcesPublished

type ResourcesPublished []schema.ResourceLink

type ResourcesUnpublished

type ResourcesUnpublished []schema.ResourceLink

type SubscriptionRequest

type SubscriptionRequest struct {
	EventsURL     string      `json:"eventsUrl"`
	EventTypes    []EventType `json:"eventTypes"`
	SigningSecret string      `json:"signingSecret"`
}

https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.r.cloudapiforcloudservices.swagger.json#/definitions/SubscribeRequestDevices https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.r.cloudapiforcloudservices.swagger.json#/definitions/SubscribeRequestDevice https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.r.cloudapiforcloudservices.swagger.json#/definitions/SubscribeRequestResources

type SubscriptionResponse

type SubscriptionResponse struct {
	SubscriptionID string `json:"subscriptionId"`
}

https://github.com/openconnectivityfoundation/cloud-services/blob/master/swagger2.0/oic.r.cloudapiforcloudservices.swagger.json#/definitions/SubscribeResponse