pvaccess

README

go-pvaccess

go-pvaccess provides a native Golang client and server for the pvAccess protocol used by the EPICS distributed control system.

It is currently pre-alpha and does not have a stable API. A limited subset of channel operations is supported, in server mode only.

Documentation

Index

• Constants
• type Channel
• type ChannelFinder
• type ChannelGetCreator
• type ChannelGeter
• type ChannelLister
• type ChannelMonitorCreator
• type ChannelProvider
• type ChannelPutCreator
• type ChannelPuter
• type ChannelRPCCreator
• type ChannelRPCer
• type Nexter
• type Server
  • func NewServer() (*Server, error)
  • func (s *Server) AddChannelProvider(provider ChannelProvider)
  • func (s *Server) ChannelProviders() []ChannelProvider
  • func (srv *Server) ListenAndServe(ctx context.Context) error
  • func (srv *Server) Serve(ctx context.Context, l net.Listener) error
• type SimpleChannel
  • func NewSimpleChannel(name string) *SimpleChannel
  • func (c *SimpleChannel) ChannelGet(ctx context.Context) (interface{}, error)
  • func (c *SimpleChannel) ChannelList(ctx context.Context) ([]string, error)
  • func (c *SimpleChannel) ChannelPut(value interface{}, ctx context.Context) (interface{}, error)
  • func (c *SimpleChannel) CreateChannel(ctx context.Context, name string) (Channel, error)
  • func (c *SimpleChannel) CreateChannelMonitor(ctx context.Context, req pvdata.PVStructure) (types.Nexter, error)
  • func (c *SimpleChannel) FieldDesc() (pvdata.FieldDesc, error)
  • func (c *SimpleChannel) Get() interface{}
  • func (c *SimpleChannel) LookupTypeCode(code pvdata.PVUShort) (pvdata.FieldDesc, error)
  • func (c *SimpleChannel) Name() string
  • func (c *SimpleChannel) Set(value interface{})
  • func (c *SimpleChannel) StoreTypeCode(code pvdata.PVUShort, desc pvdata.FieldDesc)

Constants

const (
	INIT = iota
	READY
	REQUEST_IN_PROGRESS
	CANCELLED
	DESTROYED
)

Types

type Channel

type Channel = types.Channel

type ChannelFinder

type ChannelFinder = types.ChannelFinder

type ChannelGetCreator

type ChannelGetCreator = types.ChannelGetCreator

type ChannelGeter

type ChannelGeter = types.ChannelGeter

type ChannelLister

type ChannelLister = types.ChannelLister

type ChannelMonitorCreator

type ChannelMonitorCreator = types.ChannelMonitorCreator

type ChannelProvider

type ChannelProvider = types.ChannelProvider

type ChannelPutCreator

type ChannelPutCreator = types.ChannelPutCreator

type ChannelPuter

type ChannelPuter = types.ChannelPuter

type ChannelRPCCreator

type ChannelRPCCreator = types.ChannelRPCCreator

type ChannelRPCer

type ChannelRPCer = types.ChannelRPCer

type Nexter

type Nexter = types.Nexter

type Server

type Server struct {
	DisableSearch bool
	// contains filtered or unexported fields
}

func NewServer

func NewServer() (*Server, error)

func (*Server) AddChannelProvider

func (s *Server) AddChannelProvider(provider ChannelProvider)

func (*Server) ChannelProviders

func (s *Server) ChannelProviders() []ChannelProvider

func (*Server) ListenAndServe

func (srv *Server) ListenAndServe(ctx context.Context) error

ListenAndServe listens on a random port and then calls Serve.

func (*Server) Serve

func (srv *Server) Serve(ctx context.Context, l net.Listener) error

Serve runs a PVAccess server on l until the context is cancelled.

type SimpleChannel

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

func NewSimpleChannel

func NewSimpleChannel(name string) *SimpleChannel

func (*SimpleChannel) ChannelGet

func (c *SimpleChannel) ChannelGet(ctx context.Context) (interface{}, error)

func (*SimpleChannel) ChannelList

func (c *SimpleChannel) ChannelList(ctx context.Context) ([]string, error)

func (*SimpleChannel) ChannelPut

func (c *SimpleChannel) ChannelPut(value interface{}, ctx context.Context) (interface{}, error)

func (*SimpleChannel) CreateChannel

func (c *SimpleChannel) CreateChannel(ctx context.Context, name string) (Channel, error)

func (*SimpleChannel) CreateChannelMonitor

func (c *SimpleChannel) CreateChannelMonitor(ctx context.Context, req pvdata.PVStructure) (types.Nexter, error)

func (*SimpleChannel) FieldDesc

func (c *SimpleChannel) FieldDesc() (pvdata.FieldDesc, error)

func (*SimpleChannel) Get

func (c *SimpleChannel) Get() interface{}

Get returns the current value in c.

func (*SimpleChannel) LookupTypeCode

func (c *SimpleChannel) LookupTypeCode(code pvdata.PVUShort) (pvdata.FieldDesc, error)

func (*SimpleChannel) Name

func (c *SimpleChannel) Name() string

func (*SimpleChannel) Set

func (c *SimpleChannel) Set(value interface{})

Set changes the value in c and notifies any clients that are monitoring the channel. It is not recommended to change the type of the value between calls to Set.

func (*SimpleChannel) StoreTypeCode

func (c *SimpleChannel) StoreTypeCode(code pvdata.PVUShort, desc pvdata.FieldDesc)