[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Contains settings shared by all message types for sending a message to a management point. Not all properties are recognized by all senders.

Namespace:  Microsoft.ConfigurationManagement.Messaging.Framework
Assembly:  Microsoft.ConfigurationManagement.Messaging(in Microsoft.ConfigurationManagement.Messaging.dll)

Syntax

                 
  C#     Visual Basic     Visual C++  
[
SerializableAttribute]
public 
sealed 
class 
MessageSettings : 

IMessageSettings
<
SerializableAttribute> _
Public 
NotInheritable 
Class 
MessageSettings _
	
Implements 

IMessageSettings
[
SerializableAttribute]
public 
ref class 
MessageSettings 
sealed : 

IMessageSettings

Members

                             
  All Members     Constructors      Fields      Properties      Methods   
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

  Member Description
MessageSettings () () () ()
Initializes a new instance of the MessageSettingsclass.
BitsUpload
If true, BITS will be used to send the message payload to the MP. Not all Management Point endpoints are compatible with BITS so use care when setting this to true. Not all senders support BITS uploading.
CloneSettings(MessageSettings)
Clones settings between instances. This can be used to preserve settings from one message to another. Not all settings will be cloned as some are implementation-specific to a message.
CloneSettings(MessageSettings, MessageCloneOptions)
Clones settings between instances. This can be used to preserve settings from one message to another. Not all settings will be cloned as some are implementation-specific to a message.
Compression
Get/Set the compression used with this message
CompressionLevel
Get/Set the compression level used for sending compression. This is ignored unless compression is enabled.
DefaultHttpPort
Default port for HTTP communication
DefaultHttpsPort
Default port for HTTPS communication
DefaultSecurityMode
This setting controls the default security mode for messages. This is static so this will carry across the entire process.

Defaults to mixed mode.

Endpoint
Get/Set MP Endpoint message will be sent to

IMPORTANT: It is highly recommended that this is not set by anything outside of the Messaging library (except for AdhocMessage). All messages should set this appropriately (except for AdhocMessage).

Do not set this unless you know what you're doing!

Equals(Object) (Inherited from Object.)
Finalize () () () () (Inherited from Object.)
GetCommunicationPort () () () ()
Gets the communication port that should be used for communication. The port that is returned depends on the setting for SecurityMode. If a specific override is required, use GetCommunicationPort(MessageSecurityMode)instead.
GetCommunicationPort(MessageSecurityMode)
Gets the communication port that should be used for communication. This is a hint and the actual port that should be used is specific to the implementation
GetHashCode () () () () (Inherited from Object.)
GetType () () () () (Inherited from Object.)
HostName
Management point hostname that the message will be sent to. This must be set or else message validation will fail.
HttpPort
The HTTP port to use for sending the message if applicable. Not all senders will recognize this property value. For best compatibility, GetCommunicationPort () () () () should be used to get the most appropriate port.
HttpsPort
The HTTPS (TLS/SSL) port to use for sending the message if applicable. Not all senders will recognize this property value. For best compatibility, GetCommunicationPort () () () () should be used to get the most appropriate port.
MemberwiseClone () () () () (Inherited from Object.)
MessageProperties
Special message properties. This is generally used by messages and should not be set by external code.
OverrideValidityChecks
Gets/sets the ability to override validity checking. If true, messages that have required properties that are null or empty will not fail to send.
PostSendActionsEnabled
If true, and the message supports this, asynchronous post-send task will be run
ReplyCompression
Get/Set the reply compression used with this message
ReplyEndpoint
Endpoint to direct replies to. This setting is only relevant for senders and it is not recommended that this is changed manually unless under very special circumstances.
Security
Security settings for the message
SecurityMode
Get/Set the site security mode. Default value is mixed mode
SenderProperties
Special configuration settings for specific senders. Some messages may require special sender-specific settings that can be set here.
SetCommunicationPort(MessageSecurityMode, UInt16)
Sets the communication port that should be used for communication.
SourceHost
The hostname that the message is sourced from. Defaults to the local machine's NETBIOS name, but can be any value.
Timeout
Get/Set timeout for sending message. Not all senders will honor this timeout value. Default is 60 seconds.
ToString () () () () (Inherited from Object.)

Inheritance Hierarchy

System . . :: . . Object
   Microsoft.ConfigurationManagement.Messaging.Framework . . :: . . MessageSettings

See Also