Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSChannel Interface Reference

List of all members.

Detailed Description

A DSS Server Definition object records information about a possible configuration of a MicroStrategy Intelligence Server.

Among other things it records the collection of channels on which the server will listen for, and transmit, messages. The IDSSChannel interface is used to expose information about one of these channels.

We define a channel by recording two things about it. We need to record which communication protocol is used on the channel, and on which physical port on the machine the server listens and transmits. We also give the channel a name and a limit on the number of simultaneous connections we will make on the channel.


Public Member Functions

HRESULT MaxConnection ([in] Int32 MaxConnection)
 The maximum number of simultaneous connections permitted by this communications channel.
HRESULT MaxConnection ([out, retval] Int32 *pMaxConnection)
 The maximum number of simultaneous connections permitted by this communications channel.
HRESULT Name ([in] BSTR Name)
 The name of the communications channel.
HRESULT Name ([out, retval] BSTR *pName)
 The name of the communications channel.
HRESULT port ([in] Int32 Port)
 The port number of the communications channel.
HRESULT port ([out, retval] Int32 *pPort)
 The port number of the communications channel.
HRESULT Type ([in] EnumDSSChannelType Type)
 The protocol type of the communications channel.
HRESULT Type ([out, retval] EnumDSSChannelType *pType)
 The protocol type of the communications channel.

Member Function Documentation

HRESULT IDSSChannel::MaxConnection (  [in] Int32  MaxConnection  ) 
 

The maximum number of simultaneous connections permitted by this communications channel.

Parameters:
MaxConnection The maximum number of connections.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of pMaxConnection is not allocated.

HRESULT IDSSChannel::MaxConnection (  [out, retval] Int32 *  pMaxConnection  ) 
 

The maximum number of simultaneous connections permitted by this communications channel.

Parameters:
pMaxConnection The pointer to the maximum number of connections.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of pMaxConnection is not allocated.

HRESULT IDSSChannel::Name (  [in] BSTR  Name  ) 
 

The name of the communications channel.

This is a string-valued property. It is a name used to identify the channel.

This property is the default method of the IDSSChannel interface.
We apply the usual restrictions on which strings we allow for a valid name.
Parameters:
Name New name for the channel
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER Memory for pName is not allocated.
  • DSSCOM_E_NAME_REQUIRED The name cannot be an empty string.
  • DSSCOM_E_NAME_TOO_LONG Too many characters in the proposed name.
  • DSSCOM_E_NAME_INVALID_CHAR Forbidden character in the proposed name

HRESULT IDSSChannel::Name (  [out, retval] BSTR *  pName  ) 
 

The name of the communications channel.

This is a string-valued property. It is a name used to identify the channel.

This property is the default method of the IDSSChannel interface.
We apply the usual restrictions on which strings we allow for a valid name.
Parameters:
pName A pointer to the BSTR that contains the name of the communications channel
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER Memory for pName is not allocated.
  • DSSCOM_E_NAME_REQUIRED The name cannot be an empty string.
  • DSSCOM_E_NAME_TOO_LONG Too many characters in the proposed name.
  • DSSCOM_E_NAME_INVALID_CHAR Forbidden character in the proposed name

HRESULT IDSSChannel::port (  [in] Int32  Port  ) 
 

The port number of the communications channel.

Due to a curious behavior of the MIDL compiler this property begins with a lower case 'p'.
Parameters:
Port The port number of the communications channel.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of pPort is not allocated.

HRESULT IDSSChannel::port (  [out, retval] Int32 *  pPort  ) 
 

The port number of the communications channel.

Due to a curious behavior of the MIDL compiler this property begins with a lower case 'p'.
Parameters:
pPort The pointer to the port number of the communications channel.
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of pPort is not allocated.

HRESULT IDSSChannel::Type (  [in] EnumDSSChannelType  Type  ) 
 

The protocol type of the communications channel.

Type is an enumeration-valued property. It represents the communication protocol used on the communications channel. The possible values are drawn from the enumeration EnumDSSChannelType.

The enumeration EnumDSSChannelType selects from the following values.
Constant Value Meaning
DssChannelReserved

(This is the default setting)

0 Reserved value. Do not use.
DssChannelTCPIP 1 TCP/IP communication protocol.
DssChannelConsole 2 Channel reads input from a user console.
Parameters:
Type the protocol type of the channel
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER memory for pType not allocated

HRESULT IDSSChannel::Type (  [out, retval] EnumDSSChannelType *  pType  ) 
 

The protocol type of the communications channel.

Type is an enumeration-valued property. It represents the communication protocol used on the communications channel. The possible values are drawn from the enumeration EnumDSSChannelType.

The enumeration EnumDSSChannelType selects from the following values.
Constant Value Meaning
DssChannelReserved

(This is the default setting)

0 Reserved value. Do not use.
DssChannelTCPIP 1 TCP/IP communication protocol.
DssChannelConsole 2 Channel reads input from a user console.
Parameters:
pType pointer to the protocol type of the channel
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER memory for pType not allocated

Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.