MyChannels.Nirvana.IProducer Interface Reference

Defines an object that can publish messages to the realm. More...

Inherited by MyChannels.Nirvana.Producer.

Public Member Functions
ITransaction	CreateTransaction ()
	Create a transaction More...
ITransaction	CreateTransaction (TimeSpan commitTimeout)
	Create a transaction More...
void	Purge (long eventId)
	Purge a single message. More...
void	Purge (long eventId, bool purgeJoins)
	Purge a single message. More...
void	Purge ()
	Purge all events More...
void	Purge (string filter)
	Purge all events matching the specified filter. More...
void	Purge (long startId, long endId)
	Purge a range of events. More...
void	Purge (long startId, long endId, string filter)
	Purge a range of events matching the specified filter. More...
void	Send (IMessage message)
	Send a message (non-transactional) More...

Properties
IDestination	Destination [get]
	The destination of the messages More...

Detailed Description

Defines an object that can publish messages to the realm.

Member Function Documentation

ITransaction MyChannels.Nirvana.IProducer.CreateTransaction

(

)

Create a transaction

Returns

ITransaction MyChannels.Nirvana.IProducer.CreateTransaction

(

TimeSpan

commitTimeout

)

Create a transaction

Parameters

commitTimeout

Amount of time allowed to elapse before the transaction will timeout

void MyChannels.Nirvana.IProducer.Purge

(

long

eventId

)

Purge a single message.

Only supported by Topics (Channels)

Parameters

eventId

The event id of the message you'd like to purge.

void MyChannels.Nirvana.IProducer.Purge	(	long	eventId,
		bool	purgeJoins
	)

Purge a single message.

Only supported by Topics (Channels)

Parameters

eventId	The event id of the message you'd like to purge.
purgeJoins	a Boolean specifying if the event will be removed from all subsequent joins.

void MyChannels.Nirvana.IProducer.Purge

(

)

Purge all events

Supported by Queues & Topics (Channels)

void MyChannels.Nirvana.IProducer.Purge

(

string

filter

)

Purge all events matching the specified filter.

Supported by Queues & Topics (Channels)

Parameters

filter

A filter which will be used to purge only the events which match this criteria.

void MyChannels.Nirvana.IProducer.Purge	(	long	startId,
		long	endId
	)

Purge a range of events.

Only supported by Topics (Channels)

Parameters

startEID	a long specifying the start event id of the range of events to be purged from the channel.
endEID	a long specifying the end event id of the range of events to be purged from the channel.

void MyChannels.Nirvana.IProducer.Purge	(	long	startId,
		long	endId,
		string	filter
	)

Purge a range of events matching the specified filter.

Only supported by Topics (Channels)

Parameters

startEID	a long specifying the start event id of the range of events to be purged from the channel.
endEID	a long specifying the end event id of the range of events to be purged from the channel.
filter	A filter which will be used to purge only the events which match this criteria.

void MyChannels.Nirvana.IProducer.Send

(

IMessage

message

)

Send a message (non-transactional)

Parameters

message

The message

Property Documentation

IDestination MyChannels.Nirvana.IProducer.Destination

get

The destination of the messages