Apache.Ignite.Core.Binary.IBinary Interface Reference

Defines binary objects functionality. With binary objects you are able to:

• Seamlessly interoperate between Java, .NET, and C++.
• Make any object binary with zero code change to your existing code.
• Nest binary objects within each other.
• Automatically handle circular or null references.
• Automatically convert collections and maps between Java, .NET, and C++.
• Optionally avoid deserialization of objects on the server side.
• Avoid need to have concrete class definitions on the server side.
• Dynamically change structure of the classes without having to restart the cluster.
• Index into binary objects for querying purposes.

More...

Public Member Functions
T	ToBinary< T > (object obj)
	Converts provided object to binary form. More...
IBinaryObjectBuilder	GetBuilder (Type type)
	Create builder for the given binary object type. Note that this type must be specified in BinaryConfiguration. More...
IBinaryObjectBuilder	GetBuilder (string typeName)
	Create builder for the given binary object type name. More...
IBinaryObjectBuilder	GetBuilder (IBinaryObject obj)
	Create builder over existing binary object. More...
int	GetTypeId (string typeName)
	Gets type id for the given type name. More...
ICollection< IBinaryType >	GetBinaryTypes ()
	Gets metadata for all known types. More...
IBinaryType	GetBinaryType (int typeId)
	Gets metadata for specified type id. More...
IBinaryType	GetBinaryType (string typeName)
	Gets metadata for specified type name. More...
IBinaryType	GetBinaryType (Type type)
	Gets metadata for specified type. More...
IBinaryObject	BuildEnum (string typeName, int value)
	Converts enum to a binary form. More...
IBinaryObject	BuildEnum (Type type, int value)
	Converts enum to a binary form. More...
IBinaryObject	BuildEnum (string typeName, string valueName)
	Converts enum to a binary form. More...
IBinaryObject	BuildEnum (Type type, string valueName)
	Converts enum to a binary form. More...
IBinaryType	RegisterEnum (string typeName, IEnumerable< KeyValuePair< string, int >> values)
	Registers enum type. More...

Detailed Description

Member Function Documentation

IBinaryObject Apache.Ignite.Core.Binary.IBinary.BuildEnum	(	string	typeName,
		int	value
	)

Parameters

typeName	Enum type name.
value	Enum int value.

Returns

Binary representation of the specified enum value.

IBinaryObject Apache.Ignite.Core.Binary.IBinary.BuildEnum	(	Type	type,
		int	value
	)

Parameters

type	Enum type.
value	Enum int value.

Returns

Binary representation of the specified enum value.

IBinaryObject Apache.Ignite.Core.Binary.IBinary.BuildEnum	(	string	typeName,
		string	valueName
	)

Parameters

typeName	Enum type name.
valueName	Enum value name.

Returns

Binary representation of the specified enum value.

IBinaryObject Apache.Ignite.Core.Binary.IBinary.BuildEnum	(	Type	type,
		string	valueName
	)

Parameters

type	Enum type.
valueName	Enum value name.

Returns

Binary representation of the specified enum value.

IBinaryType Apache.Ignite.Core.Binary.IBinary.GetBinaryType

(

int

typeId

)

Returns

Metadata.

IBinaryType Apache.Ignite.Core.Binary.IBinary.GetBinaryType

(

string

typeName

)

Returns

Metadata.

IBinaryType Apache.Ignite.Core.Binary.IBinary.GetBinaryType

(

Type

type

)

Returns

Metadata.

ICollection<IBinaryType> Apache.Ignite.Core.Binary.IBinary.GetBinaryTypes

(

)

Returns

Metadata.

IBinaryObjectBuilder Apache.Ignite.Core.Binary.IBinary.GetBuilder

(

Type

type

)

Parameters

type

Returns

Builder.

IBinaryObjectBuilder Apache.Ignite.Core.Binary.IBinary.GetBuilder

(

string

typeName

)

Parameters

typeName

Type name.

Returns

Builder.

IBinaryObjectBuilder Apache.Ignite.Core.Binary.IBinary.GetBuilder

(

IBinaryObject

obj

)

Parameters

obj

Returns

Builder.

int Apache.Ignite.Core.Binary.IBinary.GetTypeId

(

string

typeName

)

Parameters

typeName

Type name.

Returns

Type id.

IBinaryType Apache.Ignite.Core.Binary.IBinary.RegisterEnum	(	string	typeName,
		IEnumerable< KeyValuePair< string, int >>	values
	)

Parameters

typeName	Name of the type.
values	Mapping of enum value names to int values.

Returns

Binary type for registered enum.

T Apache.Ignite.Core.Binary.IBinary.ToBinary< T >

(

object

obj

)

Note that object's type needs to be configured in BinaryConfiguration.

Parameters

obj	Object to convert.

Returns

Converted object.