ISessionHandler Interface

  • Reference
Package:
com.microsoft.azure.servicebus
Maven Artifact:
com.microsoft.azure:azure-servicebus:3.6.7

public interface ISessionHandler

Defines the contract for registering the session message processing callback registerSessionHandler(ISessionHandler handler) or registerSessionHandler(ISessionHandler handler) for QueueClient and SubscriptionClient.

Method Summary

Modifier and Type Method and Description
abstract CompletableFuture<Void> OnCloseSessionAsync(IMessageSession session)

Called just before a session is closed by the session pump
abstract void notifyException(Throwable exception, ExceptionPhase phase)

Receiving the exceptions that passed by pump during message processing.
abstract CompletableFuture<Void> onMessageAsync(IMessageSession session, IMessage message)

The callback for message pump to pass received Messages.

Method Details

OnCloseSessionAsync

public abstract CompletableFuture OnCloseSessionAsync(IMessageSession session)

Called just before a session is closed by the session pump

Parameters:

session - session being closed

Returns:

a future that executes the action

notifyException

public abstract void notifyException(Throwable exception, ExceptionPhase phase)

Receiving the exceptions that passed by pump during message processing.

Parameters:

exception - Exception received in pump.
phase - Exception phase.

onMessageAsync

public abstract CompletableFuture onMessageAsync(IMessageSession session, IMessage message)

The callback for message pump to pass received Messages.

Parameters:

session - The MessageSession of the message.
message - The received Message.

Returns:

CompletableFuture for the message handler.

Applies to