scp_client_misc.c File Reference

Helper functions for SCP client. More...

#include "ssh/ssh.h"
#include "ssh/ssh_connection.h"
#include "ssh/ssh_request.h"
#include "ssh/ssh_misc.h"
#include "scp/scp_client.h"
#include "scp/scp_client_misc.h"
#include "debug.h"

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   SCP_TRACE_LEVEL

Functions
void	scpClientChangeState (ScpClientContext *context, ScpClientState newState)
	Update SCP client state. More...
error_t	scpClientOpenConnection (ScpClientContext *context)
	Open SSH connection. More...
error_t	scpClientEstablishConnection (ScpClientContext *context)
	Establish SSH connection. More...
void	scpClientCloseConnection (ScpClientContext *context)
	Close SSH connection. More...
error_t	scpClientSendDirective (ScpClientContext *context, const ScpDirective *directive)
	Send a SCP directive to the server. More...
error_t	scpClientReceiveDirective (ScpClientContext *context, ScpDirective *directive)
	Receive a SCP directive from the server. More...
error_t	scpClientProcessEvents (ScpClientContext *context)
	Process SCP client events. More...
error_t	scpClientCheckTimeout (ScpClientContext *context)
	Determine whether a timeout error has occurred. More...

Detailed Description

Helper functions for SCP client.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneSSH Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.4

Definition in file scp_client_misc.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   SCP_TRACE_LEVEL

Definition at line 32 of file scp_client_misc.c.

Function Documentation

scpClientChangeState()

void scpClientChangeState	(	ScpClientContext *	context,
		ScpClientState	newState
	)

Update SCP client state.

Parameters

[in]	context	Pointer to the SCP client context
[in]	newState	New state to switch to

Definition at line 53 of file scp_client_misc.c.

scpClientCheckTimeout()

error_t scpClientCheckTimeout

(

ScpClientContext *

context

)

Determine whether a timeout error has occurred.

Parameters

[in]

context

Pointer to the SCP client context

Returns

Error code

Definition at line 453 of file scp_client_misc.c.

scpClientCloseConnection()

void scpClientCloseConnection

(

ScpClientContext *

context

)

Close SSH connection.

Parameters

[in]

context

Pointer to the SCP client context

Definition at line 172 of file scp_client_misc.c.

scpClientEstablishConnection()

error_t scpClientEstablishConnection

(

ScpClientContext *

context

)

Establish SSH connection.

Parameters

[in]

context

Pointer to the SCP client context

Returns

Error code

Definition at line 139 of file scp_client_misc.c.

scpClientOpenConnection()

error_t scpClientOpenConnection

(

ScpClientContext *

context

)

Open SSH connection.

Parameters

[in]

context

Pointer to the SCP client context

Returns

Error code

Definition at line 70 of file scp_client_misc.c.

scpClientProcessEvents()

error_t scpClientProcessEvents

(

ScpClientContext *

context

)

Process SCP client events.

Parameters

[in]

context

Pointer to the SCP client context

Returns

Error code

Definition at line 379 of file scp_client_misc.c.

scpClientReceiveDirective()

error_t scpClientReceiveDirective	(	ScpClientContext *	context,
		ScpDirective *	directive
	)

Receive a SCP directive from the server.

Parameters

[in]	context	Pointer to the SCP client context
[in]	directive	SCP directive parameters

Returns

Error code

Definition at line 259 of file scp_client_misc.c.

scpClientSendDirective()

error_t scpClientSendDirective	(	ScpClientContext *	context,
		const ScpDirective *	directive
	)

Send a SCP directive to the server.

Parameters

[in]	context	Pointer to the SCP client context
[in]	directive	SCP directive parameters

Returns

Error code

Definition at line 193 of file scp_client_misc.c.