Click or drag to resize
OSIsoft, LLC

AFDataPipeSignupSuspendedException Class

Represents a signup that cannot be completed currently but could become active in the future.
Inheritance Hierarchy
SystemObject
  SystemException
    OSIsoft.AF.DataAFDataPipeSignupSuspendedException

Namespace:  OSIsoft.AF.Data
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.6.195
Syntax
[SerializableAttribute]
public class AFDataPipeSignupSuspendedException : Exception, 
	ISerializable

The AFDataPipeSignupSuspendedException type exposes the following members.

Constructors
  NameDescription
Public methodAFDataPipeSignupSuspendedException
Construct a suspended signup exception.
Public methodAFDataPipeSignupSuspendedException(String)
Construct a suspended signup exception.
Public methodAFDataPipeSignupSuspendedException(String, Exception)
Construct a suspended signup exception.
Top
Properties
  NameDescription
Public propertyData
Gets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from Exception.)
Public propertyHelpLink
Gets or sets a link to the help file associated with this exception.
(Inherited from Exception.)
Public propertyHResult
Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
(Inherited from Exception.)
Public propertyInnerException
Gets the Exception instance that caused the current exception.
(Inherited from Exception.)
Public propertyMessage
Gets a message that describes the current exception.
(Inherited from Exception.)
Public propertySource
Gets or sets the name of the application or the object that causes the error.
(Inherited from Exception.)
Public propertyStackTrace
Gets a string representation of the immediate frames on the call stack.
(Inherited from Exception.)
Public propertyTargetSite
Gets the method that throws the current exception.
(Inherited from Exception.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetBaseException
When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
When overridden in a derived class, sets the SerializationInfo with information about the exception.
(Inherited from Exception.)
Public methodGetType
Gets the runtime type of the current instance.
(Inherited from Exception.)
Public methodToString
Creates and returns a string representation of the current exception.
(Inherited from Exception.)
Top
Extension Methods
  NameDescription
Public Extension MethodIsRetryable
This extension method will indicate if the Exception is considered retryable.
(Defined by AFSDKExtension.)
Top
Remarks
If the IsSuspendedSignupEnabled or IsSuspendedSignupEnabled options are enabled then attribute signups that are suspended are indicated by an AFDataPipeSignupSuspendedException error returned in the signup call. It is not guaranteed that the signup will be established immediately when it is available, but it should be picked up within 10 minutes. If the PIPointCacheUpdatePeriod is set to a positive value, updates can be processed more promptly in some cases. When the signup is establshied and data start, an AFDataPipeSignupEstablishedEvent will be sent on the first update scan that the signup receives data.
Version Information

AFSDK

Supported in: 2.10.5
See Also
Enabling Operational Intelligence