ConfigMgrBgbSession Class

Article
12/30/2016

Represents a client notification session with a management point.

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

Inheritance Hierarchy

System.Object
Microsoft.ConfigurationManagement.Messaging.Messages.ConfigMgrBgbSession
Microsoft.ConfigurationManagement.Messaging.Messages.ConfigMgrBgbHttpSession
Microsoft.ConfigurationManagement.Messaging.Messages.ConfigMgrBgbTcpSession

Syntax

[SerializableAttribute]
public abstract class ConfigMgrBgbSession : IDisposable

[SerializableAttribute]
public ref class ConfigMgrBgbSession abstract : IDisposable

<SerializableAttribute>
Public MustInherit Class ConfigMgrBgbSession
    Implements IDisposable

Properties

	Name	Description
	ClientCertificate	Gets the client certificate to use with the client notification session.
	ClientVersion	Gets or sets the client version associated with the client notification session.
	HostName	Gets the client notification server host name.
	IsConnected	Indicates whether the session is connected.
	KeepAliveInterval	Gets or sets the interval for sending keep-alive notifications to the client notification endpoint on the management point. The default value is 15 minutes.
	Port	Gets the client notification server port number. The default value is 10123.
	SecurityMode	Gets the message security mode, if applicable.
	SessionType	Gets the client notification session type.
	SmsId	Gets the client SMSID.
	Synchronizer	Gets the synchronizer object used for thread synchronization.
	ValidateCrl	If true, the Certificate Revocation List (CRL) is verified.
	ValidateServerCertificate	If true, the server certificate is valid.

Methods

	Name	Description
	CloseSession()	Closes an active client notification session. If the session is not open, no action is taken.
	CreateSession(BgbSessionType, String, MessageSecurityMode, SmsClientId, ClientVersionBase, MessageCertificateX509)	Creates a new client notification session of a specific type using the default port.
	CreateSession(BgbSessionType, String, UInt16, MessageSecurityMode, SmsClientId, ClientVersionBase, MessageCertificateX509)	Creates a new client notification session of a specific type.
	Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Dispose(Boolean)	Implementation of IDisposable.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	InternalCloseSession()	Closes a session.
	InternalOpenSession()	Opens a session with the client notification server.
	MemberwiseClone()	(Inherited from Object.)
	OnBgbMessageReceived(ConfigMgrBgbSessionEventArgs)	Invokes the BgbMessageReceived event when a client notification message is received.
	OnBgbMessageSent(ConfigMgrBgbSessionEventArgs)	Invokes the BgbMessageSent event when a client notification message is sent.
	OnBgbSessionClosed(EventArgs)	Invokes the BgbSessionClosed event when a BGB session closes.
	OnBgbSessionOpened(EventArgs)	Invokes the BgbSessionOpened event when a BGB session opens.
	OpenSession()	Opens a client notification session using the parameters defined in the source message.
	ProcessReceivedMessage(BgbMessageType, Stream, UInt32, UInt32)	Internal handler for processing a received message.
	SendMessageImplementation(IMessage, BgbMessageType)	Implementation for sending a message to a session listener.
	SendResponseMessage(BgbResponseMessage)	Sends a response message for a request over the BGB channel.
	ToString()	(Inherited from Object.)
	Validate()	Performs message validation.
	Validate(Collection<Exception>)	Performs message validation.

Events

	Name	Description
	BgbMessageReceived	Invoked when a client notification message is received on the asynchronous channel.
	BgbMessageSent	Invoked when a client notification message is sent on the asynchronous channel.
	BgbSessionClosed	Invoked when a client notification session is closed.
	BgbSessionOpened	Invoked when a client notification session is successfully created.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via