class Illuminate / Console / Scheduling / CallbackEvent

CallbackEvent

Extends

Properties

protected

$callback string

The callback to call.

Default: null
protected

$parameters array

The parameters to pass to the method.

Default: null
protected

$result mixed

The result of the callback's execution.

Default: null
protected

$exception Throwable |null

The exception that was thrown when calling the callback, if any.

Default: null

Methods

public

__construct ( EventMutex $mutex , $callback , array $parameters , $timezone ) : void

Create a new event instance.

Parameters

public

run ( Container $container ) : mixed

Run the callback event.

Parameters

public

shouldSkipDueToOverlapping ( ) : bool

Determine if the event should skip because another process is overlapping.

public

runInBackground ( ) : void

Indicate that the callback should run in the background.

protected

execute ( $container ) : int

Run the callback.

Parameters

public

withoutOverlapping ( $expiresAt ) : $this

Do not allow the event to overlap each other.

Parameters

  • $expiresAt int
public

onOneServer ( ) : $this

Allow the event to only run on one server for each cron expression.

public

getSummaryForDisplay ( ) : string

Get the summary of the event for display.

public

mutexName ( ) : string

Get the mutex name for the scheduled command.

protected

removeMutex ( ) : void

Clear the mutex for the event.