plugin/protocol/protocol.go

// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements.  See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License.  You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package protocol

import (
	cloudv2 "github.com/cloudevents/sdk-go/v2"
)

var (
	CloudEvents = "cloudevents"
)

// Adapter protocol adapter
// transfer the message with given protocol and events message
type Adapter interface {
	// ToCloudEvent transform protocol to CloudEvent
	ToCloudEvent(interface{}) (*cloudv2.Event, error)

	//ToCloudEvents transform protocol to CloudEvent list.
	ToCloudEvents(interface{}) ([]*cloudv2.Event, error)

	//FromCloudEvent transfor CloudEvent to target protocol.
	FromCloudEvent(event *cloudv2.Event) (interface{}, error)

	// ProtocolType protocol type, protocol type should not be null
	ProtocolType() string
}