interface GatewayInterface (View source)

Methods

void
connect( string $username)

Connect to the SSH server.

bool
connected()

Determine if the gateway is connected.

void
run( string $command)

Run a command against the server (non-blocking).

void
put( string $local, string $remote)

Upload a local file to the server.

void
putString( string $remote, string $contents)

Upload a string to to the given file on the server.

string|null
nextLine()

Get the next line of output from the server.

int|bool
status()

Get the exit status of the last command.

Details

at line line 11
void connect( string $username)

Connect to the SSH server.

Parameters

string $username

Return Value

void

at line line 18
bool connected()

Determine if the gateway is connected.

Return Value

bool

at line line 26
void run( string $command)

Run a command against the server (non-blocking).

Parameters

string $command

Return Value

void

at line line 35
void put( string $local, string $remote)

Upload a local file to the server.

Parameters

string $local
string $remote

Return Value

void

at line line 44
void putString( string $remote, string $contents)

Upload a string to to the given file on the server.

Parameters

string $remote
string $contents

Return Value

void

at line line 51
string|null nextLine()

Get the next line of output from the server.

Return Value

string|null

at line line 58
int|bool status()

Get the exit status of the last command.

Return Value

int|bool