EIO_sendEvent

- send an event

SYNOPSIS

#include <$OV_HEADER/ecs/EIO/EIO.h>
int32 EIO_sendEvent
(
	EIO_ConnectionId id,
	void *pdu,
	int32 pdu_length,
	int32 createTime,
	const char *encoding_type,
	const char *event_syntax
);

DESCRIPTION

This function sends an event over an open event I/O connection to an ECS correlation engine.

Parameters

EIO_ConnectionId id

The event I/O connection ID of the connection to the target correlation engine (as set by EIO_open). If EIO_ALLCON is specified the event PDU is sent to all open event I/O connections.

void *pdu

The event PDU. Event PDUs must not contain embedded nulls for MDL events. Ber-encoded SNMP events may contain embedded nulls.

int32 pdu_length

Length in bytes of the event PDU.

int32 createTime

UTC time when this event was created, specified as the number of seconds since UNIX EPOCH (1 Jan 1970). If specified, this value overrides any other value that might be derived from the event PDU, or calculated as a default. Specify 0 to use derived or default values.

const char *encoding_type

The encoding type of the event PDU. This parameter must be specified. It is used to select the event decoder and for routing the event on output from the correlation engine.

const char *event_syntax

The event syntax of the event PDU. This parameter must be specified if there are multiple event syntaxes for the specified encoding type. This parameter may be a NULL pointer if there is just one syntax specified for the encoding type.

RETURNS

ECS_SUCCESS

Succeeded.

ECS_BAD_PARAMETER

Bad pdu or event I/O connection ID parameter

EIO_NOT_INITIALISED EIO_stackInit has not been called

EIO_BAD_CONNECTION

The specified event I/O connection is not open

EIO_NULL_CHR

Event PDU contains NULL (00) characters

These characters are not valid in MDL events

ESOK_NOT_OPEN

The socket stack has not been initialized

ESOK_COMMUNICATION_ERROR

Communications error. This error may be transient and recoverable.