BinaryMessageFormatter

.NET Framework クラス ライブラリ リファレンス

BinaryMessageFormatter クラス

バイナリ形式を使用して、オブジェクト、または関連付けられたオブジェクトのグラフ全体を、メッセージ キューのメッセージの本文にシリアル化、またはメッセージ キューのメッセージの本文から逆シリアル化します。

名前空間: System.Messaging
アセンブリ: System.Messaging (system.messaging.dll 内)
構文

Visual Basic (宣言)

Public Class BinaryMessageFormatter
    Implements IMessageFormatter, ICloneable

Visual Basic (使用法)

Dim instance As BinaryMessageFormatter

C#

public class BinaryMessageFormatter : IMessageFormatter,
 ICloneable

C++

public ref class BinaryMessageFormatter : IMessageFormatter,
 ICloneable

J#

public class BinaryMessageFormatter implements
 IMessageFormatter, ICloneable

JScript

public class BinaryMessageFormatter implements
 IMessageFormatter, ICloneable

解説

BinaryMessageFormatter は、効率的で、ほとんどのオブジェクトのシリアル化に使用できます。シリアル化の結果、コンパクトになり、高速に解析できるようになりますが、XmlMessageFormatter とは異なり、疎結合されたメッセージ処理はできません。疎結合されているとは、クライアントとサーバーは送信および受信された型のバージョン管理を独立して行うことができるということです。

アプリケーションが MessageQueue クラスのインスタンスを使用してメッセージをキューに送信するときに、フォーマッタはオブジェクトをストリームにシリアル化し、メッセージ本文に挿入します。MessageQueue を使用してキューから読み取るときは、フォーマッタがメッセージ データを Message の Body プロパティに逆シリアル化します。

BinaryMessageFormatter のスループットは、XmlMessageFormatter のスループットよりも高速です。疎結合されたメッセージ処理よりも速度を優先する場合は BinaryMessageFormatter を使用します。

使用例

Visual Basic

Imports System
Imports System.Messaging
Imports System.Drawing
Imports System.IO


Namespace MyProj
    _
   
   
   Public Class MyNewQueue
      
      
      '**************************************************
      ' Provides an entry point into the application.
      '         
      ' This example sends and receives a message from
      ' a queue.
      '**************************************************
      Public Shared Sub
 Main()
         ' Create a new instance of the class.
         Dim myNewQueue As New
 MyNewQueue()
         
         ' Create a queue on the local computer.
         CreateQueue(".\myQueue")
         
         ' Send a message to a queue.
         myNewQueue.SendMessage()
         
         ' Receive a message from a queue.
         myNewQueue.ReceiveMessage()
         
         Return
      End Sub 'Main
      
      
      '**************************************************
      ' Creates a new queue.
      '**************************************************
      Public Shared Sub
 CreateQueue(queuePath As String)
         Try
            If Not MessageQueue.Exists(queuePath)
 Then
               MessageQueue.Create(queuePath)
            Else
               Console.WriteLine((queuePath + " already exists."))
            End If
         Catch e As MessageQueueException
            Console.WriteLine(e.Message)
         End Try
      End Sub 'CreateQueue
       
      
      '**************************************************
      ' Sends an image to a queue, using the BinaryMessageFormatter.
      '**************************************************
      Public Sub SendMessage()
         Try
            
            ' Create a new bitmap.
            ' The file must be in the \bin\debug or \bin\retail folder,
 or
            ' you must give a full path to its location.
            Dim myImage As Image = Bitmap.FromFile("SentImage.bmp")
            
            ' Connect to a queue on the local computer.
            Dim myQueue As New
 MessageQueue(".\myQueue")
            
            Dim myMessage As New
 Message(myImage, New BinaryMessageFormatter())
            
            ' Send the image to the queue.
            myQueue.Send(myMessage)
         Catch e As ArgumentException
            Console.WriteLine(e.Message)
         End Try 
         
         Return
      End Sub 'SendMessage
      
      
      
      '**************************************************
      ' Receives a message containing an image.
      '**************************************************
      Public Sub ReceiveMessage()
         
         Try
            
            ' Connect to the a queue on the local computer.
            Dim myQueue As New
 MessageQueue(".\myQueue")
            
            ' Set the formatter to indicate body contains an Order.
            myQueue.Formatter = New BinaryMessageFormatter()
            
            ' Receive and format the message. 
            Dim myMessage As System.Messaging.Message
 = myQueue.Receive()
            Dim myImage As Bitmap = CType(myMessage.Body,
 Bitmap)
            
            ' This will be saved in the \bin\debug or \bin\retail folder.
            myImage.Save("ReceivedImage.bmp", System.Drawing.Imaging.ImageFormat.Bmp)
         
         
         
         'Catch
         ' Handle Message Queuing exceptions.
         
         ' Handle invalid serialization format.
         Catch e As InvalidOperationException
            Console.WriteLine(e.Message)
         
         Catch e As IOException
         End Try
         ' Handle file access exceptions.
         
         ' Catch other exceptions as necessary.
         Return
      End Sub 'ReceiveMessage
   End Class 'MyNewQueue
End Namespace 'MyProj

C#

using System;
using System.Messaging;
using System.Drawing;
using System.IO;

namespace MyProject
{
    

    /// <summary>
    /// Provides a container class for the example.
    /// </summary>
    public class MyNewQueue
    {

        //**************************************************
        // Provides an entry point into the application.
        //         
        // This example sends and receives a message from
        // a queue.
        //**************************************************

        public static void
 Main()
        {
            // Create a new instance of the class.
            MyNewQueue myNewQueue = new MyNewQueue();

            // Create a queue on the local computer.
            CreateQueue(".\\myQueue");
            
            // Send a message to a queue.
            myNewQueue.SendMessage();

            // Receive a message from a queue.
            myNewQueue.ReceiveMessage();

            return;
        }

        //**************************************************
        // Creates a new queue.
        //**************************************************

        public static void
 CreateQueue(string queuePath)
        {
            try    
                {
                if(!MessageQueue.Exists(queuePath))
                {
                    MessageQueue.Create(queuePath);
                }
                else
                {
                    Console.WriteLine(queuePath + " already exists.");
                }
            }
            catch (MessageQueueException e)
            {
                Console.WriteLine(e.Message);
            }
            
        }

        //**************************************************
        // Sends an image to a queue, using the BinaryMessageFormatter.
        //**************************************************
        
        public void SendMessage()
        {
            try{

                // Create a new bitmap.
                // The file must be in the \bin\debug or \bin\retail
 folder, or
                // you must give a full path to its location.
                Image myImage = Bitmap.FromFile("SentImage.bmp");

                // Connect to a queue on the local computer.
                MessageQueue myQueue = new MessageQueue(".\\myQueue");
                
                Message myMessage = new Message(myImage, new
 BinaryMessageFormatter());

                // Send the image to the queue.
                myQueue.Send(myMessage);
            }
            catch(ArgumentException e)
            {
                Console.WriteLine(e.Message);
            
            }

            return;
        }


        //**************************************************
        // Receives a message containing an image.
        //**************************************************
        
        public  void ReceiveMessage()
        {
                        
            try
            {

                // Connect to the a queue on the local computer.
                MessageQueue myQueue = new MessageQueue(".\\myQueue");

                // Set the formatter to indicate body contains an Order.
                myQueue.Formatter = new BinaryMessageFormatter();

                // Receive and format the message. 
                System.Messaging.Message myMessage = myQueue.Receive(); 
                Bitmap myImage = (Bitmap)myMessage.Body;
                
                // This will be saved in the \bin\debug or \bin\retail
 folder.
                myImage.Save("ReceivedImage.bmp",System.Drawing.Imaging.ImageFormat.Bmp);
                
                
            }
            
            catch (MessageQueueException)
            {
                // Handle Message Queuing exceptions.
            }

            // Handle invalid serialization format.
            catch (InvalidOperationException e)
            {
                Console.WriteLine(e.Message);
            }

            catch (IOException e)
            {
                // Handle file access exceptions.
            }
            
            // Catch other exceptions as necessary.

            return;
        }
    }
}

C++

#using <system.dll>
#using <system.messaging.dll>
#using <system.drawing.dll>

using namespace System;
using namespace System::Messaging;
using namespace System::Drawing;
using namespace System::IO;

/// <summary>
/// Provides a container class for the example.
/// </summary>
ref class MyNewQueue
{
public:

   //*************************************************
   // Creates a new queue.
   //*************************************************
   static void CreateQueue( String^ queuePath
 )
   {
      try
      {
         if (  !MessageQueue::Exists( queuePath ) )
         {
            MessageQueue::Create( queuePath );
         }
         else
         {
            Console::WriteLine(  "{0} already exists.", queuePath );
         }
      }
      catch ( MessageQueueException^ e ) 
      {
         Console::WriteLine( e->Message );
      }

   }


   //*************************************************
   // Sends an image to a queue, using the BinaryMessageFormatter.
   //*************************************************
   void SendMessage()
   {
      try
      {
         
         // Create a new bitmap.
         // The file must be in the \bin\debug or \bin\retail folder,
 or
         // you must give a full path to its location.
         Image^ myImage = Bitmap::FromFile( "SentImage::bmp" );
         
         // Connect to a queue on the local computer.
         MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
         Message^ myMessage = gcnew Message( myImage,gcnew BinaryMessageFormatter
 );
         
         // Send the image to the queue.
         myQueue->Send( myMessage );
      }
      catch ( ArgumentException^ e ) 
      {
         Console::WriteLine( e->Message );
      }

      return;
   }


   //*************************************************
   // Receives a message containing an image.
   //*************************************************
   void ReceiveMessage()
   {
      try
      {
         
         // Connect to the a queue on the local computer.
         MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
         
         // Set the formatter to indicate body contains an Order.
         myQueue->Formatter = gcnew BinaryMessageFormatter;
         
         // Receive and format the message. 
         Message^ myMessage = myQueue->Receive();
         Bitmap^ myImage = static_cast<Bitmap^>(myMessage->Body);
         
         // This will be saved in the \bin\debug or \bin\retail folder.
         myImage->Save( "ReceivedImage::bmp", System::Drawing::Imaging::ImageFormat::Bmp
 );
      }
      catch ( MessageQueueException^ ) 
      {
         
         // Handle Message Queuing exceptions.
      }
      // Handle invalid serialization format.
      catch ( InvalidOperationException^ e ) 
      {
         Console::WriteLine( e->Message );
      }
      catch ( IOException^ e ) 
      {
         
         // Handle file access exceptions.
      }

      
      // Catch other exceptions as necessary.
      return;
   }

};


//*************************************************
// Provides an entry point into the application.
//         
// This example sends and receives a message from
// a queue.
//*************************************************
int main()
{
   
   // Create a new instance of the class.
   MyNewQueue^ myNewQueue = gcnew MyNewQueue;
   
   // Create a queue on the local computer.
   MyNewQueue::CreateQueue( ".\\myQueue" );
   
   // Send a message to a queue.
   myNewQueue->SendMessage();
   
   // Receive a message from a queue.
   myNewQueue->ReceiveMessage();
   return 0;
}

J#

package MyProject;

import System.*;
import System.Messaging.*;
import System.Drawing.*;
import System.IO.*;

/// <summary>
/// Provides a container class for the example.
/// </summary>
public class MyNewQueue
{
    //**************************************************
    // Provides an entry point into the application.
    //         
    // This example sends and receives a message from
    // a queue.
    //**************************************************
    public static void main(String[]
 args)
    {
        // Create a new instance of the class.
        MyNewQueue myNewQueue = new MyNewQueue();

        // Create a queue on the local computer.
        CreateQueue(".\\myQueue");

        // Send a message to a queue.
        myNewQueue.SendMessage();

        // Receive a message from a queue.
        myNewQueue.ReceiveMessage();

        return;
    } //main

    //**************************************************
    // Creates a new queue.
    //**************************************************
    public static void CreateQueue(String
 queuePath)
    {
        try {
            if (!(MessageQueue.Exists(queuePath))) {
                MessageQueue.Create(queuePath);
            }
            else {
                Console.WriteLine(queuePath + " already exists.");
            }
        }
        catch (MessageQueueException e) {
            Console.WriteLine(e.get_Message());
        }
    } //CreateQueue

    //**************************************************
    // Sends an image to a queue, using the BinaryMessageFormatter.
    //**************************************************
    public void SendMessage()
    {
        try {
            // Create a new bitmap.
            // The file must be in the \bin\debug or \bin\retail folder,
 or
            // you must give a full path to its location.
            Image myImage = Bitmap.FromFile("SentImage.bmp");

            // Connect to a queue on the local computer.
            MessageQueue myQueue = new MessageQueue(".\\myQueue");

            Message myMessage = new Message(myImage, 
                new BinaryMessageFormatter());

            // Send the image to the queue.
            myQueue.Send(myMessage);
        }
        catch (ArgumentException e) {
            Console.WriteLine(e.get_Message());
        }
        return;
    } //SendMessage

    //**************************************************
    // Receives a message containing an image.
    //**************************************************
    public void ReceiveMessage()
    {
        try {
            // Connect to the a queue on the local computer.
            MessageQueue myQueue = new MessageQueue(".\\myQueue");

            // Set the formatter to indicate body contains an Order.
            myQueue.set_Formatter(new BinaryMessageFormatter());

            // Receive and format the message. 
            System.Messaging.Message myMessage = myQueue.Receive();
            Bitmap myImage = (Bitmap)myMessage.get_Body();

            // This will be saved in the \bin\debug or \bin\retail folder.
            myImage.Save("ReceivedImage.bmp", 
                System.Drawing.Imaging.ImageFormat.get_Bmp());
        }
        catch (MessageQueueException exp) {
            // Handle Message Queuing exceptions.
        }
        
        // Handle invalid serialization format.
        catch (InvalidOperationException e) {
            Console.WriteLine(e.get_Message());
        }

        catch (IOException e) {
            // Handle file access exceptions.
        }

        // Catch other exceptions as necessary.
        return;
    } //ReceiveMessage
} //MyNewQueue

継承階層

System.Object
  System.Messaging.BinaryMessageFormatter

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
BinaryMessageFormatter メンバ
System.Messaging 名前空間
XmlMessageFormatter
ActiveXMessageFormatter クラス
Message.Formatter
MessageQueue.Formatter

BinaryMessageFormatter コンストラクタ ()

型スタイルまたはトップ オブジェクト アセンブリのスタイルを指定せずに、BinaryMessageFormatter クラスの新しいインスタンスを初期化します。

名前空間: System.Messaging
アセンブリ: System.Messaging (system.messaging.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New BinaryMessageFormatter

C#

public BinaryMessageFormatter ()

C++

public:
BinaryMessageFormatter ()

J#

public BinaryMessageFormatter ()

JScript

public function BinaryMessageFormatter ()

解説

BinaryMessageFormatter クラスのインスタンスを使用してメッセージのシリアル化と送信を行う前に、(グラフ内のルート オブジェクトのレイアウトを定義する) TopObjectFormat プロパティの値と (オブジェクト型の記述のレイアウトを定義する) TypeFormat プロパティの値を指定する必要があります。

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
BinaryMessageFormatter クラス
BinaryMessageFormatter メンバ
System.Messaging 名前空間

BinaryMessageFormatter コンストラクタ (FormatterAssemblyStyle, FormatterTypeStyle)

BinaryMessageFormatter クラスの新しいインスタンスを初期化し、ルート オブジェクトと型の記述の形式を指定します。

名前空間: System.Messaging
アセンブリ: System.Messaging (system.messaging.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    topObjectFormat As FormatterAssemblyStyle, _
    typeFormat As FormatterTypeStyle _
)

Visual Basic (使用法)

Dim topObjectFormat As FormatterAssemblyStyle
Dim typeFormat As FormatterTypeStyle

Dim instance As New BinaryMessageFormatter(topObjectFormat,
 typeFormat)

C#

public BinaryMessageFormatter (
    FormatterAssemblyStyle topObjectFormat,
    FormatterTypeStyle typeFormat
)

C++

public:
BinaryMessageFormatter (
    FormatterAssemblyStyle topObjectFormat, 
    FormatterTypeStyle typeFormat
)

J#

public BinaryMessageFormatter (
    FormatterAssemblyStyle topObjectFormat, 
    FormatterTypeStyle typeFormat
)

JScript

public function BinaryMessageFormatter (
    topObjectFormat : FormatterAssemblyStyle, 
    typeFormat : FormatterTypeStyle
)

パラメータ

topObjectFormat

グラフのトップ (ルート) オブジェクトをシリアル化されたストリームにどのようにレイアウトするかを確認します。

typeFormat

型の記述を、シリアル化されたストリームにどのようにレイアウトするかを確認します。

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
BinaryMessageFormatter クラス
BinaryMessageFormatter メンバ
System.Messaging 名前空間

BinaryMessageFormatter コンストラクタ

BinaryMessageFormatter クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
BinaryMessageFormatter ()	型スタイルまたはトップ オブジェクト アセンブリのスタイルを指定せずに、BinaryMessageFormatter クラスの新しいインスタンスを初期化します。
BinaryMessageFormatter (FormatterAssemblyStyle, FormatterTypeStyle)	BinaryMessageFormatter クラスの新しいインスタンスを初期化し、ルート オブジェクトと型の記述の形式を指定します。

参照

関連項目

BinaryMessageFormatter クラス
BinaryMessageFormatter メンバ
System.Messaging 名前空間

BinaryMessageFormatter プロパティ

パブリック プロパティ

	名前	説明
	TopObjectFormat	アセンブリの検索および読み込みについて、グラフのトップ (ルート) オブジェクトをどのように逆シリアル化するかを定義する値を取得または設定します。
	TypeFormat	型の記述を、シリアル化されたストリームにどのようにレイアウトするかを定義する値を取得または設定します。

参照

関連項目

BinaryMessageFormatter クラス
System.Messaging 名前空間
XmlMessageFormatter
ActiveXMessageFormatter クラス
Message.Formatter
MessageQueue.Formatter

BinaryMessageFormatter メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	CanRead	フォーマッタがメッセージの内容を逆シリアル化できるかどうかを判断します。
	Clone	現在の BinaryMessageFormatter と同じ読み取り/書き込みプロパティ (ルート オブジェクト形式と型の記述形式) を持っている BinaryMessageFormatter クラスのインスタンスを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	Read	指定されたメッセージから内容を読み取り、逆シリアル化されたメッセージを格納するオブジェクトを作成します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)
	Write	オブジェクトをメッセージの本文にシリアル化します。

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

BinaryMessageFormatter クラス
System.Messaging 名前空間
XmlMessageFormatter
ActiveXMessageFormatter クラス
Message.Formatter
MessageQueue.Formatter

BinaryMessageFormatter メンバ

バイナリ形式を使用して、オブジェクト、または関連付けられたオブジェクトのグラフ全体を、メッセージ キューのメッセージの本文にシリアル化、またはメッセージ キューのメッセージの本文から逆シリアル化します。

BinaryMessageFormatter データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	BinaryMessageFormatter	オーバーロードされます。 BinaryMessageFormatter クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	TopObjectFormat	アセンブリの検索および読み込みについて、グラフのトップ (ルート) オブジェクトをどのように逆シリアル化するかを定義する値を取得または設定します。
	TypeFormat	型の記述を、シリアル化されたストリームにどのようにレイアウトするかを定義する値を取得または設定します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	CanRead	フォーマッタがメッセージの内容を逆シリアル化できるかどうかを判断します。
	Clone	現在の BinaryMessageFormatter と同じ読み取り/書き込みプロパティ (ルート オブジェクト形式と型の記述形式) を持っている BinaryMessageFormatter クラスのインスタンスを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	Read	指定されたメッセージから内容を読み取り、逆シリアル化されたメッセージを格納するオブジェクトを作成します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)
	Write	オブジェクトをメッセージの本文にシリアル化します。

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

BinaryMessageFormatter クラス
System.Messaging 名前空間
XmlMessageFormatter
ActiveXMessageFormatter クラス
Message.Formatter
MessageQueue.Formatter