EIO_removeFilter

- remove a filter from an event I/O connection

SYNOPSIS

#include <$OV_HEADER/ecs/EIO/EIO.h>
int32 EIO_removeFilter
(
	EIO_ConnectionId id,
	const char *encoding_type,
	const char *event_syntax
);

DESCRIPTION

This function removes the filter on events received from an event I/O connection.

If the encoding_type parameter is zero then the filter on the specified connection is always removed. If the event_syntax parameter is zero and the filter matches the encoding_type parameter, it is removed. Otherwise the filter is only removed if it matches both the specified encoding type and the event syntax.

Parameters

EIO_ConnectionId id

The event I/O connection ID for an open connection (as set by EIO_open).

const char *encoding_type

The encoding type of the filter to remove. If zero, all filters for this connection are removed and the event_syntax parameter is ignored.

const char *event_syntax

The event syntax of the filter to remove. If zero all filters matching the encoding_type parameter on this connection are removed.

RETURNS

ECS_SUCCESS

Succeeded.

ECS_BAD_PARAMETER

Bad 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_NOT_FOUND

No matching filter was found.

ESOK_NOT_OPEN

The socket stack has not been initialized.

ESOK_COMMUNICATION_ERROR

Communications error. This error may be transient and recoverable.