ipcserver

package

v0.0.0-...-8dfc95f Latest Latest Go to latest Published: Apr 29, 2024 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	AF_UNIX  = "unix"     // UNIX domain sockets
	AF_DGRAM = "unixgram" // UNIX domain datagram sockets as specified in net package
)

CONSTANTS * The following constants are used for the IPC communication between the connector and the other modules.

View Source

var IPCID []byte

View Source

var MODULEIDENTIFIERS map[string][]byte

IDENTIFIERS * To identify the module, the client will send a 4 byte identifier as part of the header.

View Source

var MSGTYPE map[string]byte

View Source

var SERVERIDENTIFIER [4]byte

func AddModule(identifier string, id []byte)

Add a new module identifier to the map

func Cleanup()

func LoadModules(path string)

func NewIPCID(identifier string, id []byte)

func NewIPCMessage(identifierKey string, messageType byte, data []byte) (*ipc.IPCRequest, error)

Function to create a new IPCMessage based on the identifier key

func SetServerIdentifier(id []byte)

Set the server identifier to the SERVERIDENTIFIER variable

type DataSource struct {
}

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

TYPES * Types for the IPC communication between the connector and the other modules.

func NewIPCServer(name string, identifier string) *IPCServer

NewIPCServer creates a new IPC server and returns it.

func (s *IPCServer) InitServerSocket() bool

Write a socket file and add it to the map

func (s *IPCServer) Listen()

Creates a new listener on the socket path (which should be set in the config in the future)

type ReturnData struct {
	Metadata ipc.Metadata `json:"metadata"`
	Data     interface{}  `json:"data"`
}

func (d *ReturnData) GetLogs(path string, filter string)

TODO: Where should we tell the server where to get the logs from?