EIO_close

- close the event I/O connection

SYNOPSIS

#include <$OV_HEADER/ecs/EIO/EIO.h>
int32 EIO_close(EIO_ConnectionId id);

DESCRIPTION

This function closes the event I/O connection and deallocates any resources used.

Note that ESOK_close must be called to close the socket stack connection to the ECS correlation engine.

Parameters

EIO_ConnectionId id

Event I/O connection ID of the connection to disconnect.

RETURNS

ECS_SUCCESS

Succeeded.

EIO_NOT_INITIALISED


EIO_stackInit has not been called.

ESOK_NOT_OPEN

An EIO operation was attempted when the socket stack (ESOK) was not initialized.

ESOK_COMMUNICATION_ERROR

Communications error. This error may be transient and recoverable.

ESOK_NOT_OPEN

The socket stack has not been initialized.

ESOK_RESOURCE_LIMIT

There are insufficient socket stack connections available to close the event I/O connection.