Struct within Struct, able to change inner Struct type

Question

There isn't much explaining to this, this is what I have:

public struct PACKET_HEADER
    {
        public string computerIp;
        public string computerName;
        public string computerCustomName;
    };

    public struct PACKET
    {
        public PACKET_HEADER pktHdr;
        public PACKET_DATA pktData;
    };


    public struct PACKET_DATA
    {
        public Command command;
        public string data;  
    };

    public struct DATA_MESSAGE
    {
        public string message;
    };

    public struct DATA_FILE
    {
        public string fileName;
        public long fileSize;       
    };

Basically I want the data field in PACKET_DATA to be able to be either DATA_FILE or DATA_MESSAGE. I know the type needs to be changed but I don't know what to, is generics an option?

the end result should be so that I can do either:

pktData.data.fileName or pktData.data.message

EDIT

i could do:

public struct PACKET_DATA
{
    public Command command;
    public string data;
    public DATA_MESSAGE data_message;
    public DATA_FILE data_file;
};

and just set the data_message or file to null when ever i don't need them? how would this impact the serialization / byte array and the data being sent. If I used classes would I not have the same problem

EDIT 2

public struct PACKET_MESSAGE
{
    public PACKET_HEADER pktHdr;
    public Command command;
    public DATA_MESSAGE pktData;
};

public struct PACKET_FILE
{
    public PACKET_HEADER pktHdr;
    public Command command;
    public DATA_FILE pktData;
};

Edit 3

I have a sterilizer and de-sterilizer that works with my original example, if there are no hiccups with that then the actual serialization is done.

EDIT 4

everything seems to be working, apart from one things my serializer is getting "Attempted to read or write protected memory. This is often an indication that other memory is corrupt." gunna have a look at it when post my working solution :)

EDIT 5

    public static byte[] Serialize(object anything)
    {
        int rawsize = Marshal.SizeOf(anything);
        byte[] rawdatas = new byte[rawsize];
        GCHandle handle = GCHandle.Alloc(rawdatas, GCHandleType.Pinned);
        IntPtr buffer = handle.AddrOfPinnedObject();
        Marshal.StructureToPtr(anything, buffer, false);
        handle.Free();
        return rawdatas;
    }

    public static object Deserialize(byte[] rawdatas, Type anytype)
    {
        int rawsize = Marshal.SizeOf(anytype);
        if (rawsize > rawdatas.Length)
            return null;
        GCHandle handle = GCHandle.Alloc(rawdatas, GCHandleType.Pinned);
        IntPtr buffer = handle.AddrOfPinnedObject();
        object retobj = Marshal.PtrToStructure(buffer, anytype);
        handle.Free();
        return retobj;
    }

FINAL

The structs:

public struct PACKET_HEADER
{
    public string computerIp;
    public string computerName;
    public string computerCustomName;
};

public struct PACKET
{
    public PACKET_HEADER pktHdr;
    public PACKET_DATA pktData;
};

public struct PACKET_DATA
{
    public Command command;
    public IDATA data;
    public T GetData<T>() where T : IDATA
    {
        return (T)(data);
    }
}

public interface IDATA { }

public struct DATA_MESSAGE : IDATA
{
    public string message;
}

public struct DATA_FILE : IDATA
{
    public string fileName;
    public long fileSize;
}

How to create a new Packet (probally could combine together tbh):

    public static PACKET CreatePacket(Command command)
    {
        PACKET packet;
        packet.pktHdr.computerIp = Settings.ComputerIP;
        packet.pktHdr.computerName = Settings.ComputerName;
        packet.pktHdr.computerCustomName = Settings.ComputerCustomName;

        packet.pktData.command = command;
        packet.pktData.data = null;

        return packet;
    }

    public static PACKET CreatePacket(Command command, DATA_MESSAGE data_message)
    {
        PACKET packet;
        packet.pktHdr.computerIp = Settings.ComputerIP;
        packet.pktHdr.computerName = Settings.ComputerName;
        packet.pktHdr.computerCustomName = Settings.ComputerCustomName;

        packet.pktData.command = command;
        packet.pktData.data = data_message;

        return packet;
    }

    public static PACKET CreatePacket(Command command, DATA_FILE data_file)
    {
        PACKET packet;
        packet.pktHdr.computerIp = Settings.ComputerIP;
        packet.pktHdr.computerName = Settings.ComputerName;
        packet.pktHdr.computerCustomName = Settings.ComputerCustomName;

        packet.pktData.command = command;
        packet.pktData.data = data_file;

        return packet;
    }

(de) serialization above.

Simple example:

PACKET packet = Packet.CreatePacket(command, data_file);
byte[] byData = Packet.Serialize(packet);

other end:

PACKET returnPacket = (PACKET)Packet.Deserialize(socketData.dataBuffer, typeof(PACKET));
                        // Get file
string fileName = returnPacket.pktData.GetData<DATA_FILE>().fileName;
long fileSize = returnPacket.pktData.GetData<DATA_FILE>().fileSize;

All seems to be working nice and dandy :)

just a clarification regarding your EDIT: structs, being value types, are never null. You would need a flag indicating which member was valid. — Paul Wheeler
– Paul Wheeler, Commented Dec 20, 2010 at 6:22
ye i just realised they cant be null. im thinking of having 2 types of packet, see above, would this make more sense ? — Metalstorm
– Metalstorm, Commented Dec 20, 2010 at 6:34
Ok, but keep in mind the code that deserializes will need to determine the type. I actually liked your two child structs version, you just needed a bool isMessagePacket;. — Paul Wheeler
– Paul Wheeler, Commented Dec 20, 2010 at 8:03
Also regarding your memory access error, what method are you using to convert byte arrays to structs and vice versa? Since your structs already contain Strings, which are a class reference and therefore not stored inline in the struct, I'm not sure why you're using structs at all. You may as well just use classes, mark the whole thing with [Serializable] and use a BinaryFormatter for serialization. — Paul Wheeler
– Paul Wheeler, Commented Dec 20, 2010 at 8:04
@Paul have a look at Edit 5, hmmm classes are starting to seem the better way — Metalstorm
– Metalstorm, Commented Dec 20, 2010 at 8:13

Paul Wheeler · Accepted Answer · 2010-12-20 17:05:43Z

4

This question needs a clear answer, so I'll try to sum up:

If you want to take a C# data structure and convert it into a byte array, you can do it with structs and Marshaling, or with classes (or structs, but why would you) and a serialization framework (like BinaryFormatter), or custom serialization logic (like with BinaryWriter). We could have a debate about which is better, but lets assume for now that we're going with structs, and we're using Marshaling. Although I will say, that structs are very limited, and should be used mainly as necessary for interop with Win32 API functions.

So the issue is, we have a container struct, which may contain one of two types of child structs. If you're going to Marshal a struct, things like generics and or using a common Interface for your child struct types are not going to fly. Basically you're only option is to have the container have both structs and a bool flag indicating which of the structures is to be used. This has the downside of increasing the size of your packets because you're sending the unused child struct as well.

In the case at hand, the result looks like this:

public struct PACKET_DATA
{
    public Command command;
    public string data;
    public bool is_message_packet;
    public DATA_MESSAGE data_message;
    public DATA_FILE data_file;
};

That said, in your case using structs and Marshalling is only really going to work within your own process, because your structs contain Strings. When a struct contains pointers to non-fixedlength strings, those strings are allocated elsewhere and will not be part of the byte array you copy, only pointers to them will be. You also need to call Marshal.DestroyStructure at some point, with the IntPtr you passed to StructureToPtr, in order to clean up these string resources.

So the moral of the story: can you make structs that do what you asked initially: yes. Should you be using them like you are: no. Because you have a variable size data structure that you are trying to send over a network (I presume since the struct is called PACKET), structs are not going to work, you really need to use some kind of serialization framework or custom serialization logic.

edited Dec 20, 2010 at 17:05

answered Dec 20, 2010 at 9:13

Paul Wheeler

20.3k3 gold badges33 silver badges47 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Metalstorm Over a year ago

Have a look at my final edit Paul, all seems to be working fine

Paul Wheeler Over a year ago

I think the fact that it is "working" is a fantasy because you're using test code in a single process. Take that code, and try sending the data via a network socket, and I'm almost certain it will fail. This is because the strings your struct contains are not stored with the struct, the marshaled struct just has pointers to them, they are allocated elsewhere.

Paul Wheeler Over a year ago

Also, when a struct contains an interface member, it treats that member as a reference. In other words, the parent struct contains a pointer, instead of containing the child struct inline. This definitely will not fly.

Cheng Chen · Accepted Answer · 2010-12-20 12:14:12Z

1

    public struct PACKET_DATA
    {
        public IData data;
        public T GetData<T>() where T : IDATA
        {
           return (T)data;
        }
    }

    public interface IDATA { }

    public struct DATA_MESSAGE : IDATA
    {
        public string message;
    }

    public struct DATA_FILE : IDATA
    {
        public string fileName;
        public long fileSize;
    }

PACKET_DATA packetData = new PACKET_DATA();
packetData.data = new DATA_MESSAGE();
var message = packetData.GetData<DATA_MESSAGE>().message;

edited Dec 20, 2010 at 12:14

answered Dec 20, 2010 at 6:41

Cheng Chen

43.7k18 gold badges118 silver badges184 bronze badges

3 Comments

Metalstorm Over a year ago

public struct PACKET { public PACKET_HEADER pktHdr; public PACKET_DATA<> pktData; }; isnt that the problem like before? what goes between the <> if its T then the PACKET struct will also have to take a T ? making it messy

Metalstorm Over a year ago

ive tried implementing this, it look all good apart from under the T in "return T(data);" it comes back with the error 'T' is a 'type parameter' but is used like a 'variable'

Cheng Chen Over a year ago

@Metalstorm: It's a typo. Should be (T)data.

Joe Albahari · Accepted Answer · 2010-12-20 05:51:00Z

0

You can do it with generics, but then a type parameter will propagate to the PACKET struct which I'm guessing will make it awkward to work with and not be what you want.

What's the purpose of using structs here, rather than classes? Is it for interop? (In which case, the interop scenario will dictate the right solution). Or is it to avoid boxing / heap allocation?

answered Dec 20, 2010 at 5:51

Joe Albahari

31.2k7 gold badges85 silver badges97 bronze badges

2 Comments

Metalstorm Over a year ago

"You can do it with generics, but then a type parameter will propagate to the PACKET struct which I'm guessing will make it awkward to work with and not be what you want." yep i had a look at that but indeed it does get very messy. The Packet struct ( and its contents) gets serialized and send over a network as a byte array. The purpose is just to store a small amount of information for a short amount of time, i read that structs are better for this rather than classes.

Joe Albahari Over a year ago

Is it mainly that you want efficient serialization? If so, the optimial approach is to write a custom serializer. The overhead of making these types classes instead of structs (in terms of the GC) is not great.

Ohio Enthusiast · Accepted Answer · 2010-12-20 06:44:02Z

0

How about defining a bogus interface that both structs inherit from? Of course this will not solve your serialization issues, but as was said, you'd probably need a custom serialization method anyway.

public interface IDataType
{
}

public struct PACKET_DATA
{
    public Command command;
    public IDataType data;  
};

public struct DATA_MESSAGE : IDataType
{
    public string message;
};

public struct DATA_FILE : IDataType
{
    public string fileName;
    public long fileSize;       
};

answered Dec 20, 2010 at 6:44

Ohio Enthusiast

2,8341 gold badge21 silver badges30 bronze badges

1 Comment

Metalstorm Over a year ago

this looks nice, however when i try PACKET packet; packet.pktData.data. nothing comes next apart from the standard ToString etc

Collectives™ on Stack Overflow

Struct within Struct, able to change inner Struct type

4 Answers 4

3 Comments

3 Comments

2 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

3 Comments

3 Comments

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related