15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NET_FTP_FTP_TRANSACTION_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define NET_FTP_FTP_TRANSACTION_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/completion_callback.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/io_buffer.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/load_states.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/net_export.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class AuthCredentials; 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FtpResponseInfo; 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FtpRequestInfo; 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BoundNetLog; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Represents a single FTP transaction. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT_PRIVATE FtpTransaction { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Stops any pending IO and destroys the transaction object. 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~FtpTransaction() {} 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Starts the FTP transaction (i.e., sends the FTP request). 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns OK if the transaction could be started synchronously, which means 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // that the request was served from the cache (only supported for directory 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // listings). ERR_IO_PENDING is returned to indicate that the 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // CompletionCallback will be notified once response info is available or if 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // an IO error occurs. Any other return value indicates that the transaction 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // could not be started. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Regardless of the return value, the caller is expected to keep the 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // request_info object alive until Destroy is called on the transaction. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: The transaction is not responsible for deleting the callback object. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Profiling information for the request is saved to |net_log| if non-NULL. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int Start(const FtpRequestInfo* request_info, 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const CompletionCallback& callback, 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const BoundNetLog& net_log) = 0; 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Restarts the FTP transaction with authentication credentials. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int RestartWithAuth(const AuthCredentials& credentials, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const CompletionCallback& callback) = 0; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Once response info is available for the transaction, response data may be 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // read by calling this method. 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Response data is copied into the given buffer and the number of bytes 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // copied is returned. ERR_IO_PENDING is returned if response data is not 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // yet available. The CompletionCallback is notified when the data copy 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // completes, and it is passed the number of bytes that were successfully 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // copied. Or, if a read error occurs, the CompletionCallback is notified of 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the error. Any other negative return value indicates that the transaction 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // could not be read. 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: The transaction is not responsible for deleting the callback object. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int Read(IOBuffer* buf, 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int buf_len, 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const CompletionCallback& callback) = 0; 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the response info for this transaction or NULL if the response 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // info is not available. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual const FtpResponseInfo* GetResponseInfo() const = 0; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the load state for this transaction. 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual LoadState GetLoadState() const = 0; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the upload progress in bytes. If there is no upload data, 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // zero will be returned. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual uint64 GetUploadProgress() const = 0; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_FTP_FTP_TRANSACTION_H_ 81