ESOK_open

- open a connection to an ECS correlation engine

SYNOPSIS

#include <$OV_HEADER/ecs/ESOK/sockstack.h>
int32 ESOK_open
(
	const ESOK_Remote *remote,
	ESOK_ConnectionId *conId
);

DESCRIPTION

This function opens a connection to an ECS correlation engine.

A client can open one or more connections to one or more ECS correlation engines. Up to ESOK_MAXCON connections can be opened with a single correlation engine.

Parameters

const ESOK_Remote *remote

Remote end identity and protocol information structure to use when establishing connections.

See ESOK_buildRemote.

ESOK_ConnectionId *conId

On return conId is set to the value of the connection ID.

RETURNS

ECS_SUCCESS

Succeeded.

ECS_BAD_PARAMETER

Bad parameter.

ESOK_NOT_INITIALISED

ESOK_stackInit has not been called.

ESOK_RESOURCE_LIMIT

No more socket stack connections availableESOK_MAXCON exceeded.

ESOK_COMMUNICATION_ERROR

Communications error. This error may be transient and recoverable.