guacamole-spice-protocol/src/protocols/ssh/sftp.h

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is libguac-client-ssh.
 *
 * The Initial Developer of the Original Code is
 * Michael Jumper.
 * Portions created by the Initial Developer are Copyright (C) 2011
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef _SSH_GUAC_SFTP_H
#define _SSH_GUAC_SFTP_H

#include <guacamole/client.h>
#include <guacamole/stream.h>

/**
 * Maximum number of bytes per path.
 */
#define GUAC_SFTP_MAX_PATH 2048

/**
 * Handler for file messages which begins an SFTP data transfer (upload).
 */
int guac_sftp_file_handler(guac_client* client, guac_stream* stream,
        char* mimetype, char* filename);

/**
 * Handler for blob messages which continues an SFTP data transfer (upload).
 */
int guac_sftp_blob_handler(guac_client* client, guac_stream* stream,
        void* data, int length);

/**
 * Handler for end messages which ends an SFTP data transfer (upload).
 */
int guac_sftp_end_handler(guac_client* client, guac_stream* stream);

/**
 * Handler for ack messages which continues an SFTP download.
 */
int guac_sftp_ack_handler(guac_client* client, guac_stream* stream,
        char* message, guac_protocol_status status);

/**
 * Begins (and automatically continues) an SFTP file download to the user.
 */
guac_stream* guac_sftp_download_file(guac_client* client, char* filename);

/**
 * Set the destination directory for future uploads.
 */
void guac_sftp_set_upload_path(guac_client* client, char* path);

#endif