Edit

WS_CUSTOM_CHANNEL_CALLBACKS structure (webservices.h)

  • Article

A structure that is used to specify a set of callbacks that form the implementation of a custom channel.

Syntax

typedef struct _WS_CUSTOM_CHANNEL_CALLBACKS {
  WS_CREATE_CHANNEL_CALLBACK           createChannelCallback;
  WS_FREE_CHANNEL_CALLBACK             freeChannelCallback;
  WS_RESET_CHANNEL_CALLBACK            resetChannelCallback;
  WS_OPEN_CHANNEL_CALLBACK             openChannelCallback;
  WS_CLOSE_CHANNEL_CALLBACK            closeChannelCallback;
  WS_ABORT_CHANNEL_CALLBACK            abortChannelCallback;
  WS_GET_CHANNEL_PROPERTY_CALLBACK     getChannelPropertyCallback;
  WS_SET_CHANNEL_PROPERTY_CALLBACK     setChannelPropertyCallback;
  WS_WRITE_MESSAGE_START_CALLBACK      writeMessageStartCallback;
  WS_WRITE_MESSAGE_END_CALLBACK        writeMessageEndCallback;
  WS_READ_MESSAGE_START_CALLBACK       readMessageStartCallback;
  WS_READ_MESSAGE_END_CALLBACK         readMessageEndCallback;
  WS_ABANDON_MESSAGE_CALLBACK          abandonMessageCallback;
  WS_SHUTDOWN_SESSION_CHANNEL_CALLBACK shutdownSessionChannelCallback;
} WS_CUSTOM_CHANNEL_CALLBACKS;

Members

createChannelCallback

The callback that implements WsCreateChannel. See WS_CREATE_CHANNEL_CALLBACK for more information.

freeChannelCallback

The callback that implements WsFreeChannel. See WS_FREE_CHANNEL_CALLBACK for more information.

resetChannelCallback

The callback that implements WsResetChannel. See WS_RESET_CHANNEL_CALLBACK for more information.

openChannelCallback

The callback that implements WsOpenChannel. See WS_OPEN_CHANNEL_CALLBACK for more information.

closeChannelCallback

The callback that implements WsCloseChannel. See WS_CLOSE_CHANNEL_CALLBACK for more information.

abortChannelCallback

The callback that implements WsAbortChannel. See WS_ABORT_CHANNEL_CALLBACK for more information.

getChannelPropertyCallback

The callback that implements WsGetChannelProperty. See WS_GET_CHANNEL_PROPERTY_CALLBACK for more information.

setChannelPropertyCallback

The callback that implements WsSetChannelProperty. See WS_SET_CHANNEL_PROPERTY_CALLBACK for more information.

writeMessageStartCallback

The callback that implements WsWriteMessageStart. See WS_WRITE_MESSAGE_START_CALLBACK for more information.

writeMessageEndCallback

The callback that implements WsWriteMessageEnd. See WS_WRITE_MESSAGE_END_CALLBACK for more information.

readMessageStartCallback

The callback that implements WsReadMessageStart. See WS_READ_MESSAGE_START_CALLBACK for more information.

readMessageEndCallback

The callback that implements WsReadMessageEnd. See WS_READ_MESSAGE_END_CALLBACK for more information.

abandonMessageCallback

The callback that implements WsAbandonMessage. See WS_ABANDON_MESSAGE_CALLBACK for more information.

shutdownSessionChannelCallback

The callback that implements WsShutdownSessionChannel. See WS_SHUTDOWN_SESSION_CHANNEL_CALLBACK for more information.

Remarks

This structure is specified when a channel is created using WsCreateChannel or WsCreateChannelForListener using WS_CHANNEL_PROPERTY_CUSTOM_CHANNEL_CALLBACKS.

Except where noted, each callback is responsible for validating all parameters and that the operation requested is acceptable given the current WS_CHANNEL_STATE.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Header webservices.h