Class CommandSettings

Namespace

Lers.Poll

Assembly

Lers.System.dll

Описывает параметры ответа для команды.

public class CommandSettings

Inheritance

object

CommandSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EnumerableExtensions.Yield<T>(T)

CastExtensions.CastTo<T>(object)

Constructors

CommandSettings(string, int, int, byte)

Конструктор.

public CommandSettings(string commandTitle, int timeOut, int responseLength, byte maxAttempts)

Parameters

commandTitle string

Наименование команды

timeOut int

Таймаут ожидания ответа (мсек)

responseLength int

Максимальная длина ответа (байт)

maxAttempts byte

Количество попыток отправки команды.

CommandSettings(string, int, int, int, byte)

Конструктор.

public CommandSettings(string commandTitle, int timeOut, int minRespLen, int maxRespLen, byte maxAttempts)

Parameters

commandTitle string

Наименование команды

timeOut int

Таймаут ожидания ответа (мсек)

minRespLen int

Минимальная длина ответа

maxRespLen int

Максимальная длина ответа (байт)

maxAttempts byte

Количество попыток отправки команды.

Properties

LastByteTimeout

Таймаут, который должен пройти после последнего байта. Это считается окончанием ответа от устройства.

public int LastByteTimeout { get; }

Property Value

int

MaxAttempts

Максимально возможное количество повторов запроса.

public int MaxAttempts { get; }

Property Value

int

MaxResponseLength

Максимальная длина ответа.

public int MaxResponseLength { get; }

Property Value

int

MinResponseLength

Минимальная длина ответа.

public int MinResponseLength { get; }

Property Value

int

RequestId

Идентификатор запроса. Он будет скопирован в ответ.

public int RequestId { get; }

Property Value

int

ResponseReadType

Указывает способ чтения ответа.

public ResponseReadType ResponseReadType { get; }

Property Value

ResponseReadType

Timeout

Таймаут выполнения команды.

public int Timeout { get; }

Property Value

int

UseCommLinkLayer

Флаг указывает, что запрос будет "заворачиваться" в формат коммуникационного оборудования.

public bool UseCommLinkLayer { get; }

Property Value

bool

Remarks

Его необходимо установить, если запрос формируется к устройству, которое подключено к коммуникационному оборудованию. Если же запрос формируется непосредственно к коммуникацинному устройству (GPRS-модему, например), здесь нужно указать false.

Methods

CreateCommControllerDirectRequest(int, int, int)

Создаёт параметры команды для выполнения запроса к коммуникационному контроллеру. Ответ на запрос требуется.

public static CommandSettings CreateCommControllerDirectRequest(int timeout, int lastByteTimeout, int maxAttempts)

Parameters

timeout int

Таймаут выполнения команды (мс).

lastByteTimeout int

Таймаут, который сообщает службе опроса, что пакет от контроллера считан полностью (мс).

maxAttempts int

Количество попыток для выполнения запроса.

Returns

CommandSettings

CreateLastByteTimeoutRequest(int, int, int, bool)

Создаёт параметры команды для выполнения запроса. Ответ на запрос требуется.

public static CommandSettings CreateLastByteTimeoutRequest(int timeout, int lastByteTimeout, int maxAttempts, bool useCommLink)

Parameters

timeout int

Таймаут выполнения команды (мс).

lastByteTimeout int

Таймаут, который сообщает службе опроса, что пакет от контроллера считан полностью (мс).

maxAttempts int

Количество попыток для выполнения запроса.

useCommLink bool

Указывает что запрос должен быть упакован в формате коммуникационного оборудования (если оно есть).

Returns

CommandSettings

GetSendOnlySettings(string)

Возвращает параметры команды, которая будет отправлена в порт, но ответ считан не будет.

public static CommandSettings GetSendOnlySettings(string commandTitle)

Parameters

commandTitle string

Returns

CommandSettings