Class ErrorInfo
Object representing full details about a signaling error or status.
All ErrorInfo object returned by the liblinphone API are readonly and transcients. For safety they must be used immediately after obtaining them. Any other function call to the liblinphone may change their content or invalidate the pointer.
Inherited Members
Namespace: Linphone
Assembly: cs.temp.dll.dll
Syntax
public class ErrorInfo : LinphoneObject
Properties
Phrase
Get textual phrase from the error info.
This is the text that is provided by the peer in the protocol (SIP).
Declaration
public string Phrase { get; set; }
Property Value
Type | Description |
---|---|
System.String | The error phrase |
Protocol
Get protocol from the error info.
Declaration
public string Protocol { get; set; }
Property Value
Type | Description |
---|---|
System.String | The protocol. |
ProtocolCode
Get the status code from the low level protocol (ex a SIP status code).
Declaration
public int ProtocolCode { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The status code |
Reason
Get reason code from the error info.
Declaration
public Reason Reason { get; set; }
Property Value
Type | Description |
---|---|
Reason | A Reason object |
RetryAfter
Get Retry-After delay second from the error info.
Declaration
public int RetryAfter { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The Retry-After delay second |
SubErrorInfo
Get pointer to chained ErrorInfo set in sub_ei.
It corresponds to a Reason header in a received SIP response.
Declaration
public ErrorInfo SubErrorInfo { get; set; }
Property Value
Type | Description |
---|---|
ErrorInfo | ErrorInfo pointer defined in the ei object. |
Warnings
Provides additional information regarding the failure.
With SIP protocol, the content of "Warning" headers are returned.
Declaration
public string Warnings { get; set; }
Property Value
Type | Description |
---|---|
System.String | More details about the failure. |
Methods
Set(String, Reason, Int32, String, String)
Assign information to a ErrorInfo object.
Declaration
public void Set(string protocol, Reason reason, int code, string status, string warning)
Parameters
Type | Name | Description |
---|---|---|
System.String | protocol | protocol name |
Reason | reason | reason from Reason enum |
System.Int32 | code | protocol code |
System.String | status | description of the reason |
System.String | warning | warning message |