FTPファイル書き込みクラス [詳解]

#include <TnbFtpFile.h>

CFtpFileWriter の継承関係図

公開型
enum	ESeekMode { TOP = FILE_BEGIN , CURRENT = FILE_CURRENT , END = FILE_END }
	シークのオフセット指定モード [詳解]

公開メンバ関数
virtual void	AddRaw (size_t size, LPCVOID P)
	[追加] 追加. [詳解]

virtual bool	CanRead (void) const
	[確認] 読み込み可能か [詳解]

virtual bool	CanWrite (void) const
	[確認] 書込み可能か [詳解]

virtual void	Close (void)
	[操作] クローズ [詳解]

LONGLONG	GetLeftoverSize (void) const
	[取得] 残りサイズ取得. [詳解]

LPCTSTR	GetOpenName (void) const
	[取得] オープン名取得 [詳解]

virtual void	GetRaw (size_t size, LPVOID _P) const
	[取得] 取得. [詳解]

virtual LONGLONG	GetSize (void) const
	[取得] サイズ取得 [詳解]

bool	New (CFtpSession &sec, LPCTSTR lpszFileName, DWORD dwFlags=FTP_TRANSFER_TYPE_BINARY, DWORD_PTR dwContext=0)
	[取得] ファイルオープン. [詳解]

bool	Open (CFtpSession &sec, LPCTSTR lpszFileName, DWORD dwFlags=FTP_TRANSFER_TYPE_BINARY, DWORD_PTR dwContext=0)
	[取得] ファイルオープン. [詳解]

template<typename T >
ISerializer &	operator<< (const T &t)
	[追加] 追加. [詳解]

template<typename T >
const IDeserializer &	operator>> (T &_t) const
	[取得] 取得. [詳解]

virtual size_t	Read (size_t size, LPVOID _P) const
	[取得] 読み込み [詳解]

void	ReadExactly (size_t size, LPVOID _P) const
	[取得] 読み込み. [詳解]

CByteVector	ReadExactly (size_t size=0) const
	[取得] 読み込み [詳解]

size_t	ReadInto (ICollectionT< BYTE > &_out, size_t size=0, size_t oneBlockSize=4096) const
	[取得] 読み込み. [詳解]

CByteVector	ReadInto (size_t size=0) const
	[取得] 読み込み [詳解]

LONGLONG	Seek (LONGLONG llOffset, ESeekMode eSeek=TOP) const
	[操作] シーク. [詳解]

virtual void	SetEnd (void)
	[設定] EOFを指定. [詳解]

virtual void	Write (size_t size, LPCVOID P)
	[保存] ファイル書き込み [詳解]

void	WriteFrom (const IConstCollectionT< BYTE > &c)
	[保存] 書き込み. [詳解]

void	WriteFrom (const IReader &reader, size_t size=0, size_t oneBlockSize=4096)
	[保存] 書き込み. [詳解]

詳解

FTPファイル書き込みクラス

必要ファイル: TnbFtpFile.h

日付: 07/01/16 新規

TnbFtpFile.h の 537 行目に定義があります。

列挙型メンバ詳解

◆ ESeekMode

enum ESeekMode

inherited

シークのオフセット指定モード

列挙値
TOP	頭からのオフセット指定
CURRENT	現在位置からのオフセット指定
END	末からのオフセット指定

TnbReader.h の 38 行目に定義があります。

関数詳解

◆ AddRaw()

virtual void AddRaw	(	size_t	size,
		LPCVOID	P
	)

virtualinherited

[追加] 追加.

指定データを追加します。

引数

size	追加するデータサイズ(単位BYTE)
P	追加するデータ

例外

CTnbException 失敗時は、任意のスローの可能性があります。

ISerializerを実装しています。

TnbWriter.h の 115 行目に定義があります。

◆ CanRead()

virtual bool CanRead ( void ) const

virtual

[確認] 読み込み可能か

戻り値

true	可能
false	不可能

IReaderを実装しています。

TnbFtpFile.h の 623 行目に定義があります。

◆ CanWrite()

virtual bool CanWrite ( void ) const

virtual

[確認] 書込み可能か

戻り値

true	可能
false	不可能

IWriterを実装しています。

TnbFtpFile.h の 633 行目に定義があります。

◆ Close()

virtual void Close ( void )

virtual

[操作] クローズ

IReaderを実装しています。

TnbFtpFile.h の 546 行目に定義があります。

◆ GetLeftoverSize()

LONGLONG GetLeftoverSize ( void ) const

inherited

[取得] 残りサイズ取得.

現在の位置から最後までのサイズを返します。

戻り値

０以上	サイズ
マイナス	取得失敗

TnbReader.h の 95 行目に定義があります。

◆ GetOpenName()

LPCTSTR GetOpenName ( void ) const

virtual

[取得] オープン名取得

戻り値: 名前

IReaderを実装しています。

TnbFtpFile.h の 613 行目に定義があります。

◆ GetRaw()

virtual void GetRaw	(	size_t	size,
		LPVOID	_P
	)		const

virtualinherited

[取得] 取得.

指定データを取得します。

引数

[in]	size	取得するデータサイズ(単位BYTE)
[out]	_P	取得するデータ

例外

CTnbException 失敗時は、任意のスローの可能性があります。

IDeserializerを実装しています。

TnbReader.h の 211 行目に定義があります。

◆ GetSize()

virtual LONGLONG GetSize ( void ) const

virtual

[取得] サイズ取得

戻り値

０以上	サイズ
マイナス	取得失敗

IReaderを実装しています。

TnbFtpFile.h の 700 行目に定義があります。

◆ New()

bool New	(	CFtpSession &	sec,
		LPCTSTR	lpszFileName,
		DWORD	dwFlags = `FTP_TRANSFER_TYPE_BINARY`,
		DWORD_PTR	dwContext = `0`
	)

[取得] ファイルオープン.

FTPセッションのFileNameで指定されたファイルを新規作成する。

引数

sec	オープンしたセッションハンドル。
lpszFileName	オープンするファイルの名前。
dwFlags	ファイル転送の種別を表すフラグ。省略すると FTP_TRANSFER_TYPE_BINARY 。まず以下のいずれかを指定する。 FTP_TRANSFER_TYPE_ASCII ASCII転送。 FTP_TRANSFER_TYPE_BINARY バイナリ転送。次に、以下の任意の組み合わせを論理和によって指定する。 INTERNET_FLAG_HYPERLINK 再読み込みすべきかどうかの判断時に有効期限・最終更新時刻がサーバから返されない場合強制的に再読み込みする。 INTERNET_FLAG_MAKE_PERSISTENT キャッシュに永続的要素として追加する。これにより、通常のキャッシュのクリーンアップ、整合性チェック、ごみは行きなどの際にこの要素が削除されない。 INTERNET_FLAG_RELOAD 要求したファイル、オブジェクト、ディレクトリリストをキャッシュから取得するのでなく、強制的にサーバから再読み込みする。 INTERNET_FLAG_RESYNCHRONIZE FTPリソースをサーバから再読み込みする。 INTERNET_FLAG_NEED_FILE ファイルがキャッシュできない場合に一時ファイルを作成する。
dwContext	コールバックに渡すアプリケーション定義の値。省略可能。

戻り値

true	オープン成功
false	オープン失敗

TnbFtpFile.h の 599 行目に定義があります。

◆ Open()

bool Open	(	CFtpSession &	sec,
		LPCTSTR	lpszFileName,
		DWORD	dwFlags = `FTP_TRANSFER_TYPE_BINARY`,
		DWORD_PTR	dwContext = `0`
	)

[取得] ファイルオープン.

FTPセッションのFileNameで指定されたファイルを書き込み可能でオープンする。

引数

sec	オープンしたセッションハンドル。
lpszFileName	オープンするファイルの名前。
dwFlags	ファイル転送の種別を表すフラグ。省略すると FTP_TRANSFER_TYPE_BINARY 。まず以下のいずれかを指定する。 FTP_TRANSFER_TYPE_ASCII ASCII転送。 FTP_TRANSFER_TYPE_BINARY バイナリ転送。次に、以下の任意の組み合わせを論理和によって指定する。 INTERNET_FLAG_HYPERLINK 再読み込みすべきかどうかの判断時に有効期限・最終更新時刻がサーバから返されない場合強制的に再読み込みする。 INTERNET_FLAG_MAKE_PERSISTENT キャッシュに永続的要素として追加する。これにより、通常のキャッシュのクリーンアップ、整合性チェック、ごみは行きなどの際にこの要素が削除されない。 INTERNET_FLAG_RELOAD 要求したファイル、オブジェクト、ディレクトリリストをキャッシュから取得するのでなく、強制的にサーバから再読み込みする。 INTERNET_FLAG_RESYNCHRONIZE FTPリソースをサーバから再読み込みする。 INTERNET_FLAG_NEED_FILE ファイルがキャッシュできない場合に一時ファイルを作成する。
dwContext	コールバックに渡すアプリケーション定義の値。省略可能。

戻り値

true	オープン成功
false	オープン失敗

TnbFtpFile.h の 571 行目に定義があります。

◆ operator<<()

ISerializer & operator<< ( const T & t )

inherited

[追加] 追加.

指定データをシリアライズして追加します。

引数

t データ

戻り値: 自分の参照

例外

CNotSupportException	シリアライズをサポートしていない型が指定されると、スローされます。
CTnbException	失敗時は、任意のスローの可能性があります。

TnbSerializer.h の 161 行目に定義があります。

◆ operator>>()

const IDeserializer & operator>> ( T & _t ) const

inherited

[取得] 取得.

指定データをデシリアライズして取得します。

引数

[out] _t データ

戻り値: 自分の参照

例外

CNotSupportException	デシリアライズをサポートしていない型が指定されると、スローされます。
CTnbException	失敗時は、任意のスローの可能性があります。

TnbSerializer.h の 277 行目に定義があります。

◆ Read()

virtual size_t Read	(	size_t	size,
		LPVOID	_P
	)		const

virtual

[取得] 読み込み

引数

[in]	size	読み込みサイズ。
[out]	_P	読み込みアドレス。 size 分書き込める領域である必要が有ります。

戻り値: 読み込めたサイズ。

例外

CReadFailureException 読み込みに失敗すると、スローされます。

IReaderを実装しています。

TnbFtpFile.h の 645 行目に定義があります。

◆ ReadExactly() [1/2]

void ReadExactly	(	size_t	size,
		LPVOID	_P
	)		const

inherited

[取得] 読み込み.

覚え書き: 指定サイズ読めないとエラーになります。

引数

[in]	size	読み込みサイズ。
[out]	_P	読み込みアドレス。 size 分書き込める領域である必要が有ります。

例外

CReadFailureException	読み込みに失敗すると、スローされます。
CShortOfDataException	指定サイズ読込めないと、スローされます。

TnbReader.h の 114 行目に定義があります。

◆ ReadExactly() [2/2]

CByteVector ReadExactly ( size_t size = 0 ) const

inherited

[取得] 読み込み

覚え書き: 指定サイズ読めないとエラーになります。

引数

size	読み込みサイズ。0ならファイル最後まで読み込む。

戻り値: ByteVector ファイル内容（サイズは読み込めたサイズ）。

例外

CReadFailureException	読み込みに失敗すると、スローされます。
CShortOfDataException	指定サイズ読込めないと、スローされます。

TnbReader.h の 134 行目に定義があります。

◆ ReadInto() [1/2]

size_t ReadInto	(	ICollectionT< BYTE > &	_out,
		size_t	size = `0`,
		size_t	oneBlockSize = `4096`
	)		const

inherited

[取得] 読み込み.

引数

[out]	_out	読込先。クリアせず、後ろに追加します。
	size	読み込みサイズ。省略か0ならファイル最後まで読み込む。
	oneBlockSize	一度に読み込むサイズ。省略なら４K。

戻り値: 読み込めたサイズ。

例外

CReadFailureException 読み込みに失敗すると、スローされます。

TnbReader.h の 178 行目に定義があります。

◆ ReadInto() [2/2]

CByteVector ReadInto ( size_t size = 0 ) const

inherited

[取得] 読み込み

引数

size	読み込みサイズ。0ならファイル最後まで読み込む。

戻り値: ByteVector ファイル内容（サイズは読み込めたサイズ）。

例外

CReadFailureException 読み込みに失敗すると、スローされます。

TnbReader.h の 150 行目に定義があります。

◆ Seek()

LONGLONG Seek	(	LONGLONG	llOffset,
		ESeekMode	eSeek = `TOP`
	)		const

virtual

[操作] シーク.

ファイルポインタを移動します。

注意: ファイルポインタの移動は、空読み込みすることで、行なっています。その為、パフォーマンスは良くありません。また、現在のポインタより前に戻る場合、再オープンされます。

引数

llOffset	ファイルポインタの移動数。
eSeek	移動開始ファイルポインタ位置。省略すると TOP になります。

戻り値

０以上	シーク成功。数値は、現在のファイルポインタ
マイナス	シーク失敗

IReaderを実装しています。

TnbFtpFile.h の 690 行目に定義があります。

◆ SetEnd()

virtual void SetEnd ( void )

virtual

[設定] EOFを指定.

例外

CNotSupportException サポートしていないため、スローされます。

IWriterを実装しています。

TnbFtpFile.h の 654 行目に定義があります。

◆ Write()

virtual void Write	(	size_t	size,
		LPCVOID	P
	)

virtual

[保存] ファイル書き込み

引数

size	書き込みサイズ。
P	書き込みデータ。

例外

CWriteFailureException 書込みに失敗すると、スローされます。

IWriterを実装しています。

TnbFtpFile.h の 665 行目に定義があります。

◆ WriteFrom() [1/2]

void WriteFrom ( const IConstCollectionT< BYTE > & c )

inherited

[保存] 書き込み.

覚え書き: 内部で一度 CVectorT<BYTE> に変換しています。

引数

c 書き込みデータ。

例外

CWriteFailureException 書込みに失敗すると、スローされます。

TnbWriter.h の 65 行目に定義があります。

◆ WriteFrom() [2/2]

void WriteFrom	(	const IReader &	reader,
		size_t	size = `0`,
		size_t	oneBlockSize = `4096`
	)

inherited

[保存] 書き込み.

覚え書き: reader の現在の位置から読み出し、書き込みます。

引数

reader	書き込みデータ。
size	読み込みサイズ。省略か０ならファイル最後まで読み込む。
oneBlockSize	一度に読み込むサイズ。省略なら４K。

例外

CReadFailureException	読み込みに失敗すると、スローされます。
CWriteFailureException	書込みに失敗すると、スローされます。

TnbWriter.h の 85 行目に定義があります。

公開型

公開メンバ関数

詳解

列挙型メンバ詳解

◆ ESeekMode

関数詳解

◆ AddRaw()

◆ CanRead()

◆ CanWrite()

◆ Close()

◆ GetLeftoverSize()

◆ GetOpenName()

◆ GetRaw()

◆ GetSize()

◆ New()

◆ Open()

◆ operator<<()

◆ operator>>()

◆ Read()

◆ ReadExactly() [1/2]

◆ ReadExactly() [2/2]

◆ ReadInto() [1/2]

◆ ReadInto() [2/2]

◆ Seek()

◆ SetEnd()

◆ Write()

◆ WriteFrom() [1/2]

◆ WriteFrom() [2/2]