C# 클래스 OpenHome.Net.Device.DvInvocation

Utility class used by providers to read input and write output arguments

Only intended for use by auto-generated providers

상속: IDvInvocation

보호된 프로퍼티들

프로퍼티	타입	설명
iHandle	System.IntPtr

공개 메소드들

메소드	설명
Adapter ( ) : uint	Get the network adapter an action was invoked using.
DvInvocation ( IntPtr aHandle ) : System	Constructor
GetClientEndpoint ( uint &aAddress, uint &aPort ) : void	Get the endpoint of the client.
ReadBinary ( String aName ) : byte[]	Read the value of a binary input argument for an invocation
ReadBool ( String aName ) : bool	Read the value of a boolean input argument for an invocation
ReadEnd ( ) : void	Complete reading (input arguments for) an invocation Must be called after the values of all input arguments are read. Must be called for invocations with no input arguments.
ReadInt ( String aName ) : int	Read the value of an integer input argument for an invocation
ReadStart ( ) : void	Begin reading (input arguments for) an invocation Must be called before the values of any input arguments are read. Must be called for invocations with no input arguments.
ReadString ( String aName ) : String	Read the value of a string input argument for an invocation
ReadUint ( String aName ) : uint	Read the value of an unsigned integer input argument for an invocation
ReportActionError ( ActionError aException, string aActionName ) : void
ReportError ( uint aCode, String aDescription ) : void	Report an error reading or writing an invocation Must be called if ReadEnd() isn't reached. May be called if WriteStart() or later have been called.
ResourceUriPrefix ( ) : string	Get the prefix to use on any uris to resources offered by the provider.
Version ( ) : uint	Get the version number of the service requested by the caller.
WriteBinary ( String aName, byte aData ) : void	Set the value of a binary output argument for an invocation.
WriteBool ( String aName, bool aValue ) : void	Set the value of a boolean output argument for an invocation.
WriteEnd ( ) : void	Complete writing (output arguments for) an invocation Must be called after the values of all output arguments are written. Must be called for invocations with no output arguments.
WriteInt ( String aName, int aValue ) : void	Set the value of an integer output argument for an invocation.
WriteStart ( ) : void	Begin reading (output arguments for) an invocation Must be called before the values of any output arguments are written. Must be called for invocations with no output arguments.
WriteString ( String aName, String aValue ) : void	Set the value of a string output argument for an invocation.
WriteUint ( String aName, uint aValue ) : void	Set the value of an unsigned integer output argument for an invocation.

비공개 메소드들

메소드	설명
CheckError ( int aError ) : void
DvInvocationGetAdapter ( IntPtr aInvocation, uint &aAdapter ) : void
DvInvocationGetClientEndpoint ( IntPtr aInvocation, uint &aAddress, uint &aPort ) : void
DvInvocationGetResourceUriPrefix ( IntPtr aInvocation, IntPtr &aPrefix, uint &aLen ) : void
DvInvocationGetVersion ( IntPtr aInvocation, uint &aVersion ) : void
DvInvocationReadBinary ( IntPtr aInvocation, IntPtr aName, IntPtr &aData, uint &aLen ) : int
DvInvocationReadBool ( IntPtr aInvocation, IntPtr aName, uint &aValue ) : int
DvInvocationReadEnd ( IntPtr aInvocation ) : int
DvInvocationReadInt ( IntPtr aInvocation, IntPtr aName, int &aValue ) : int
DvInvocationReadStart ( IntPtr aInvocation ) : int
DvInvocationReadStringAsBuffer ( IntPtr aInvocation, IntPtr aName, IntPtr &aValue, uint &aLen ) : int
DvInvocationReadUint ( IntPtr aInvocation, IntPtr aName, uint &aValue ) : int
DvInvocationReportError ( IntPtr aInvocation, uint aCode, IntPtr aDescription ) : int
DvInvocationWriteBinary ( IntPtr aInvocation, IntPtr aData, uint aLen ) : int
DvInvocationWriteBinaryEnd ( IntPtr aInvocation, IntPtr aName ) : int
DvInvocationWriteBinaryStart ( IntPtr aInvocation, IntPtr aName ) : int
DvInvocationWriteBool ( IntPtr aInvocation, IntPtr aName, uint aValue ) : int
DvInvocationWriteEnd ( IntPtr aInvocation ) : int
DvInvocationWriteInt ( IntPtr aInvocation, IntPtr aName, int aValue ) : int
DvInvocationWriteStart ( IntPtr aInvocation ) : int
DvInvocationWriteString ( IntPtr aInvocation, IntPtr aValue ) : int
DvInvocationWriteStringEnd ( IntPtr aInvocation, IntPtr aName ) : int
DvInvocationWriteStringStart ( IntPtr aInvocation, IntPtr aName ) : int
DvInvocationWriteUint ( IntPtr aInvocation, IntPtr aName, uint aValue ) : int
OhNetFree ( IntPtr aPtr ) : void

메소드 상세

Adapter() 공개 메소드

Get the network adapter an action was invoked using.

public Adapter ( ) : uint
리턴	uint

DvInvocation() 공개 메소드

Constructor

public DvInvocation ( IntPtr aHandle ) : System
aHandle	System.IntPtr	'aInvocation' argument to ActionDelegate
리턴	System

GetClientEndpoint() 공개 메소드

Get the endpoint of the client.

public GetClientEndpoint ( uint &aAddress, uint &aPort ) : void
aAddress	uint	IPv4 address in network byte order
aPort	uint	Client's port [1..65535]
리턴	void

ReadBinary() 공개 메소드

Read the value of a binary input argument for an invocation

public ReadBinary ( String aName ) : byte[]
aName	String	Name of the parameter associated with this input argument
리턴	byte[]

ReadBool() 공개 메소드

Read the value of a boolean input argument for an invocation

public ReadBool ( String aName ) : bool
aName	String	Name of the parameter associated with this input argument
리턴	bool

ReadEnd() 공개 메소드

Complete reading (input arguments for) an invocation

Must be called after the values of all input arguments are read. Must be called for invocations with no input arguments.

public ReadEnd ( ) : void
리턴	void

ReadInt() 공개 메소드

Read the value of an integer input argument for an invocation

public ReadInt ( String aName ) : int
aName	String	Name of the parameter associated with this input argument
리턴	int

ReadStart() 공개 메소드

Begin reading (input arguments for) an invocation

Must be called before the values of any input arguments are read. Must be called for invocations with no input arguments.

public ReadStart ( ) : void
리턴	void

ReadString() 공개 메소드

Read the value of a string input argument for an invocation

public ReadString ( String aName ) : String
aName	String	Name of the parameter associated with this input argument
리턴	String

ReadUint() 공개 메소드

Read the value of an unsigned integer input argument for an invocation

public ReadUint ( String aName ) : uint
aName	String	Name of the parameter associated with this input argument
리턴	uint

ReportActionError() 공개 메소드

public ReportActionError ( ActionError aException, string aActionName ) : void
aException	ActionError
aActionName	string
리턴	void

ReportError() 공개 메소드

Report an error reading or writing an invocation

Must be called if ReadEnd() isn't reached. May be called if WriteStart() or later have been called.

public ReportError ( uint aCode, String aDescription ) : void
aCode	uint	Error code
aDescription	String	Error description
리턴	void

ResourceUriPrefix() 공개 메소드

Get the prefix to use on any uris to resources offered by the provider.

public ResourceUriPrefix ( ) : string
리턴	string

Version() 공개 메소드

Get the version number of the service requested by the caller.

public Version ( ) : uint
리턴	uint

WriteBinary() 공개 메소드

Set the value of a binary output argument for an invocation.

public WriteBinary ( String aName, byte aData ) : void
aName	String	Name of the parameter associated with this output argument
aData	byte	Value of the output argument
리턴	void

WriteBool() 공개 메소드

Set the value of a boolean output argument for an invocation.

public WriteBool ( String aName, bool aValue ) : void
aName	String	Name of the parameter associated with this output argument
aValue	bool	Value of the output argument
리턴	void

WriteEnd() 공개 메소드

Complete writing (output arguments for) an invocation

Must be called after the values of all output arguments are written. Must be called for invocations with no output arguments.

public WriteEnd ( ) : void
리턴	void

WriteInt() 공개 메소드

Set the value of an integer output argument for an invocation.

public WriteInt ( String aName, int aValue ) : void
aName	String	Name of the parameter associated with this output argument
aValue	int	Value of the output argument
리턴	void

WriteStart() 공개 메소드

Begin reading (output arguments for) an invocation

Must be called before the values of any output arguments are written. Must be called for invocations with no output arguments.

public WriteStart ( ) : void
리턴	void

WriteString() 공개 메소드

Set the value of a string output argument for an invocation.

public WriteString ( String aName, String aValue ) : void
aName	String	Name of the parameter associated with this output argument
aValue	String	Value of the output argument
리턴	void

WriteUint() 공개 메소드

Set the value of an unsigned integer output argument for an invocation.

public WriteUint ( String aName, uint aValue ) : void
aName	String	Name of the parameter associated with this output argument
aValue	uint	Value of the output argument
리턴	void

프로퍼티 상세

iHandle 보호되어 있는 프로퍼티

protected IntPtr,System iHandle
리턴	System.IntPtr