Open Mash Cross Reference
mash/tcl/indiva/lib/ascp-packet.tcl

   # ascp-packet.tcl --

   #

   #   This object represents an ASCP message/packet.  We hide the format

   #   and the content of the packet from the users, so that we can easily

   #   add a new field, or rearrange the fields.

   #

   # Copyright (c) 1996-2002 The Regents of the University of California.

   # All rights reserved.

   #

  # Redistribution and use in source and binary forms, with or without

  # modification, are permitted provided that the following conditions are met:

  #

  # A. Redistributions of source code must retain the above copyright notice,

  #    this list of conditions and the following disclaimer.

  # B. Redistributions in binary form must reproduce the above copyright notice,

  #    this list of conditions and the following disclaimer in the documentation

  #    and/or other materials provided with the distribution.

  # C. Neither the names of the copyright holders nor the names of its

  #    contributors may be used to endorse or promote products derived from this

  #    software without specific prior written permission.

  #

  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''

  # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

  # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

  # ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR

  # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

  # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

  # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

  # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

  # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

  # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  #

  # @(#) $Header: /usr/mash/src/repository/mash/mash-1/tcl/indiva/lib/ascp-packet.tcl,v 1.1 2002/05/28 20:04:23 weitsang Exp $

  
  
  #--------------------------------------------------------------------------

  # Class:

  #   ASCPPacket

  # Description:

  #   This object represents an ASCP message/packet.  We hide the format

  #   and the content of the packet from the users, so that we can easily

  #   add a new field, or rearrange the fields.  The method to_string{}

  #   converts the packet to a string (for transmission) and method 

  #   from_string{} parses a packet into an object.  Method from_ascp{} takes

  #   in an operation and an ASCP object, and copies the contents of the packet 

  #   from the ASCP object.  Individual fields can be queried or modified using

  #   methods named after the field.

  # See Also:

  #   ASCP, ASCP/Client, ASCP/Server, ASCP/Manager

  #--------------------------------------------------------------------------

  
  Class ASCPPacket
  
  ASCPPacket instproc init { } {
      $self instvar agent_type_ agent_id_ args_ operation_ 
      $self instvar service_type_ service_location_ service_instance_ ssg_port_
      $self instvar precondition_
  
      set agent_type_ "-"
      set agent_id_ "-"
      set operation_ "-"
      set service_type_ "-"
      set service_location_ "-"
      set service_instance_ "-"
      set precondition_ "-"
      set ssg_port_ "-"
      set args_ "-"
  }
  
  ASCPPacket instproc to_string { } {
      $self instvar agent_type_ agent_id_ args_ operation_ 
      $self instvar service_type_ service_location_ service_instance_ ssg_port_
      $self instvar precondition_ 
      
      set o "ASCP v[ASCP version]\n"
      append o "$agent_type_\n"
      append o "$agent_id_\n"
      append o "$operation_\n"
      append o "$service_type_\n"
      append o "$service_location_\n"
      append o "$service_instance_\n"
      append o "$precondition_\n"
      append o "$ssg_port_\n"
      append o "$args_\n"
  
      return $o
  }
  
  
  ASCPPacket instproc from_ascp { operation ascp } {
      $self instvar agent_type_ agent_id_ args_ operation_ precondition_
      $self instvar service_type_ service_location_ service_instance_ ssg_port_
      set agent_type_ [$ascp agent_type]
      set agent_id_   [$ascp agent_id]
      set operation_  $operation
      set service_type_     [$ascp service_type]
      set service_location_ [$ascp service_location]
      set service_instance_ [$ascp service_instance]
      set precondition_   [$ascp precondition]
     set ssg_port_   [$ascp ssg_port]
     set args_ [$ascp args]
 }
 
 
 ASCPPacket instproc from_string { str } {
     $self instvar agent_type_ agent_id_ args_ operation_ precondition_
     $self instvar service_type_ service_location_ service_instance_ ssg_port_
     set o [split $str \n]
     if {[lindex $o 0] != "ASCP v[ASCP version]"} {
         return "invalid version"
     }
     set agent_type_ [lindex $o 1]
     set agent_id_   [lindex $o 2]
     set operation_  [lindex $o 3]
     set service_type_     [lindex $o 4]
     set service_location_ [lindex $o 5]
     set service_instance_ [lindex $o 6]
     set precondition_   [lindex $o 7]
     set ssg_port_   [lindex $o 8]
     set args_ [join [lrange $o 9 end] \n]
 }
 
 ASCPPacket instproc agent_type { args } {
     $self instvar agent_type_
     if {$args == ""} {
         return $agent_type_
     } else {
         set agent_type_ $args
     }
 }
 
 
 ASCPPacket instproc agent_id { args } {
     $self instvar agent_id_
     if {$args == ""} {
         return $agent_id_
     } else {
         set agent_id_ $args
     }
 }
 
 
 
 ASCPPacket instproc operation { args } {
     $self instvar operation_
     if {$args == ""} {
         return $operation_
     } else {
         set operation_ $args
     }
 }
 
 
 ASCPPacket instproc service_type { args } {
     $self instvar service_type_
     if {$args == ""} {
         return $service_type_
     } else {
         set service_type_ $args
     }
 }
 
 
 ASCPPacket instproc service_location { args } {
     $self instvar service_location_
     if {$args == ""} {
         return $service_location_
     } else {
         set service_location_ $args
     }
 }
 
 
 ASCPPacket instproc service_instance { args } {
     $self instvar service_instance_
     if {$args == ""} {
         return $service_instance_
     } else {
         set service_instance_ $args
     }
 }
 
 
 ASCPPacket instproc precondition { args } {
     $self instvar precondition_
     if {$args == ""} {
         return $precondition_
     } else {
         set precondition_ [lindex $args 0]
     }
 }
 
 
 ASCPPacket instproc ssg_port { args } {
     $self instvar ssg_port_
     if {$args == ""} {
         return $ssg_port_
     } else {
         set ssg_port_ $args
     }
 }
 
 
 ASCPPacket instproc args { args } {
     $self instvar args_
     if {$args == ""} {
         return $args_
     } else {
         set args_ [lindex $args 0]
     }
 }