Encode Method

Summary

Encodes JPIP parameters and creates a valid System.Net.HttpWebRequest.

Syntax

C++/CLI

Python

public HttpWebRequest Encode( 
   RequestFields fields, 
   string path, 
   byte[] postedData 
)

public: 
HttpWebRequest^ Encode(  
   RequestFields^ fields, 
   String^ path, 
   array<byte>^ postedData 
)

def Encode(self,fields,path,postedData):

Parameters

fields
The Leadtools.Jpip.RequestFields to be transmitted to the JPIP server.

path
A System.String value identifying the server URI.

postedData
An array of bytes to be sent in the request message body. This value can be null.

Return Value

An System.Net.HttpWebRequest ready to transmit the JPIP request to the server.

Remarks

If postedData is specified, the System.Net.HttpWebRequest will be created with a POST method and all fields will be encoded to the message body.

You can use the postedData parameter to optimize the process of encoding when sending cache information.

If postedData is null the System.Net.HttpWebRequest will be created with a Get method with the fields encoded in the request URL.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Jpip; 
using Leadtools.Jpip.Caching; 
using Leadtools.Jpip.HttpServer; 
using Leadtools.Jpip.RequestDecoder; 
using Leadtools.Jpip.RequestEncoder; 
using Leadtools.Jpip.Client.WinForms; 
using Leadtools.Jpip.Client.InteractiveDecoder; 
using Leadtools.Jpip.Server; 
using Leadtools.Jpip.Logging; 
 
public void SendClientRequest() 
{ 
   Leadtools.Examples.Support.SetLicense(); 
   RequestFields fields = new RequestFields(); 
   ModelItem cacheModleItem; 
   ExplicitBinDescriptor binDescriptor; 
   ModelElement cacheModleElement; 
 
   fields.RequestTargetFields = new TargetFields("0", "image1.jp2", null); 
   fields.RequestChannelFields.NewChannel = new string[] { "http" }; 
   fields.RequestDataLimitFields.DataLength = 16384; 
   cacheModleItem = new ModelItem(); 
   binDescriptor = new ExplicitBinDescriptor(ExplicitBin.MetaBin, 0, null); //indicate that metadata bin 0 is locally cached and need not be sent. 
   cacheModleElement = new ModelElement(false, binDescriptor); 
   cacheModleItem.BinDescriptors.Add(cacheModleElement); 
   cacheModleItem.CodeStreamRange.Add(new Range(0, 0)); 
   fields.RequestCacheManagementFields.ModelItems.Add(cacheModleItem); 
   ImageReturnType imageType = new ImageReturnType(ImageTypes.JppStream, false); 
   fields.RequestServerControlFields.ImageReturnTypes = new ImageReturnType[] { imageType }; 
   fields.RequestViewWindowFields.FrameSize = new LeadSize(500, 300); 
   fields.RequestViewWindowFields.RegionOffset = new LeadPoint(0, 100); 
   fields.RequestViewWindowFields.FrameSizeRoundingDirection = RoundingDirection.Closest; 
   SampleRange codeStreamRange = new SampleRange(); 
   codeStreamRange.Range = new Range(0, 0); 
   fields.RequestViewWindowFields.CodeStream.Add(codeStreamRange); 
   HttpRequestEncoder encoder = new HttpRequestEncoder(IPAddress.Parse("127.0.0.1"), 108); 
   HttpWebRequest request = encoder.Encode(fields, "jpip", null); 
   Console.WriteLine(request.Address.ToString()); 
   HttpWebResponse response = (HttpWebResponse)request.GetResponse(); 
   Console.WriteLine("Server response received."); 
   Console.WriteLine(response.Headers.ToString()); 
} 
 
public Socket GetClientSocket() 
{ 
   Socket listenSocket = new Socket(AddressFamily.InterNetwork, 
                                     SocketType.Stream, 
                                     ProtocolType.Tcp); 
   IPAddress hostIP = IPAddress.Parse("127.0.0.1"); 
   int port = 107; 
   IPEndPoint ep = new IPEndPoint(hostIP, port); 
   listenSocket.Bind(ep); 
   // start listening 
   listenSocket.Listen(10); 
   //a client should send a request to the listening address 
   Socket client = listenSocket.Accept(); 
   listenSocket.Close(); 
   return client; 
}

Requirements

Target Platforms

Reference

HttpRequestEncoder Class

HttpRequestEncoder Members

Download our FREE evaluation

Help Version 22.0.2023.3.31

Leadtools.Jpip Assembly

Introduction

Getting Started

Namespaces

Leadtools.Jpip Namespace

Leadtools.Jpip.Caching Namespace

Leadtools.Jpip.JPX Namespace

Leadtools.Jpip.RequestEncoder Namespace

Assemblies