output_binding.go

/*
Copyright 2021 The Dapr Authors
Licensed 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 bindings

import (
	"context"
	"errors"
	"io"

	"github.com/dapr/components-contrib/health"
	"github.com/dapr/components-contrib/metadata"
)

// OutputBinding is the interface for an output binding, allowing users to invoke remote systems with optional payloads.
type OutputBinding interface {
	metadata.ComponentWithMetadata

	Init(ctx context.Context, metadata Metadata) error
	Invoke(ctx context.Context, req *InvokeRequest) (*InvokeResponse, error)
	Operations() []OperationKind
	io.Closer
}

func PingOutBinding(ctx context.Context, outputBinding OutputBinding) error {
	// checks if this output binding has the ping option then executes
	if outputBindingWithPing, ok := outputBinding.(health.Pinger); ok {
		return outputBindingWithPing.Ping(ctx)
	} else {
		return errors.New("ping is not implemented by this output binding")
	}
}