DispatchNotification

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

DispatchNotification

The DispatchNotification function indicates whether a message was successfully queued.

Syntax

bool DispatchNotification(
  string methodName,
  string value,
  string value,...
);

Parameters

  • methodName
    The name of a method in the managed code application that will receive the dispatched message and process it.

  • Value
    A context-specific parameter that is of type bool, int, float, string, or any type that can be cast to a string, or whose value is null.

  • Value,...
    Optional. One or more additional context-specific parameters that are of type bool, int, float, string, or any type that can be cast to a string, or whose value is null.

Return Values

Returns true if the message was successfully queued; else false.

Remarks

The DispatchNotification function is a one-way remote procedure call alternative to the Dispatch function. The DispatchNotification function is intended for use when you must call managed code outside of the scope of a transaction, or when the caller does not care about reliability. The function assembles a packet containing the context-specific information to pass to the managed code application, and queues it for delivery. Because the procedure call is one-way, SPL script execution continues, making it necessary to proxy or dispatch the message.

Note

The DispatchNotification function cannot be called after the message has been proxied or dispatched.

Use the DispatchNotification function when the following conditions apply:

  • The application will not alter the message.

  • Routing is independent of application execution.

  • The application needs responses but not requests.

For example, use the DispatchNotification function with applications that collect metrics, applications that report response errors, or applications that trigger other applications.