運用コマンドレファレンス Vol.1


eventmonitor.regist_cron_timer

cronタイマを登録します。

[関数名]

regist_cron_timer(cron, priority = eventmonitor.NORMAL)

[引数]

cron

'<minute> <hour> <day> <month> <week>'

指定した時刻にイベントを発行させます。指定できる値の範囲を次に示します。

<minute>

分を指定します。{0-59|*}

<hour>

時間を指定します。{0-23|*}

<day>

日を指定します。{1-31|*}

<month>

月を指定します。{1-12|*}

<week>

曜日を指定します。{0-7|*}

(0,7=日曜,1=月曜,2=火曜,...,6=土曜)

指定規則および設定例については,[備考]を参照してください。

priority

本タイマが発生したときの通知優先度を指定します。

  • eventmonitor.HIGH:高

  • eventmonitor.NORMAL:中(デフォルト値)

  • eventmonitor.LOW:低

  • eventmonitor.LAST:最低

通知優先度が高/中/低のイベントは,次の割合で通知します。

高:中:低 = 6:3:1

通知優先度が最低のイベントは,高/中/低のイベントをすべて通知したあと,通知します。

[戻り値]

整数型

監視イベントID(一意の値)

[例外]

表20‒8 eventmonitor.regist_cron_timerの例外クラス一覧

例外クラス名

説明

TypeError

引数の型に誤りがあります。

ValueError

引数に不正な値が指定されています。

SystemError

システムエラーが発生しました。

KeyboardInterrupt

[Ctrl+C]の入力によってコマンドが中断されました。

eventmonitor.RegisterMax

イベント登録数が上限に達しています。

eventmonitor.RegistrationError

イベント登録に失敗しました。

[詳細]

引数に指定したcronタイマを登録します。

正常終了の場合,戻り値に監視イベントID(正の整数)の値が格納されます。異常終了の場合,例外を返します。

cronタイマ監視登録は,intervalタイマ監視登録と合わせて装置当たり最大256件まで登録できます。256件を超えた場合は例外(eventmonitor.RegisterMax)を返します。

[注意事項]

  1. cronタイマのイベント発生時刻をわたって時刻を変更(サマータイムの開始/終了による時刻変更を含む)した場合,発生時刻をわたって時刻を進めるとイベントが発生しないことがあり,発生時刻をわたって時刻を戻すとイベントが2度発生することがあります。

[備考]